Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Next local runner job

POST/v1/private/local-runners/{runnerId}/jobs/nextNext local runner job

Long-poll for the next pending local runner job

Parameters

runnerIdstring · uuidpathrequired

Responses

200Job available, or null if no pending jobsapplication/json
value
anyOf · 2 options
Option 1value
allOf · 1 option
Option 1objectLocalRunnerJob
agent_namestring
blueprint_namestring

pattern (?s)^\s*(\S.*\S|\S)\s*$

completed_atstring · date-time
created_atstring · date-time
errorstring
idstring · uuid
inputsobject
mask_idstring · uuid

Deprecated. Use prompt_masks to read one or more mask overlays keyed by prompt id.

metadataobject
Show child attributes
dataset_idstring · uuid
dataset_item_idstring · uuid
dataset_item_version_idstring · uuid
dataset_version_idstring · uuid
project_idstring · uuid
prompt_masksobject

Mask overlays to apply during agent execution, keyed by prompt id.

resultobject
runner_idstring · uuid
started_atstring · date-time
statusstring

one of "pending", "running", "completed", "failed", "cancelled"

timeoutinteger · int32
trace_idstring · uuid
Option 2nullnullable
Example response
{
  "agent_name": "string",
  "blueprint_name": "string",
  "completed_at": "2026-06-09T00:00:00Z",
  "created_at": "2026-06-09T00:00:00Z",
  "error": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "inputs": {},
  "mask_id": "00000000-0000-0000-0000-000000000000",
  "metadata": {
    "dataset_id": "00000000-0000-0000-0000-000000000000",
    "dataset_item_id": "00000000-0000-0000-0000-000000000000",
    "dataset_item_version_id": "00000000-0000-0000-0000-000000000000",
    "dataset_version_id": "00000000-0000-0000-0000-000000000000"
  },
  "project_id": "00000000-0000-0000-0000-000000000000",
  "prompt_masks": {
    "additionalProp1": "00000000-0000-0000-0000-000000000000"
  },
  "result": {},
  "runner_id": "00000000-0000-0000-0000-000000000000",
  "started_at": "2026-06-09T00:00:00Z",
  "status": "cancelled",
  "timeout": 0,
  "trace_id": "00000000-0000-0000-0000-000000000000"
}
404Not foundapplication/json
objectErrorMessage
codeinteger · int32
detailsstring
messagestring
Example response
{
  "code": 0,
  "details": "string",
  "message": "string"
}
Documentation menu