For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETGet local runner job logs
        • POSTAppend local runner job logs
        • POSTCancel local runner job
        • POSTSubmit bridge command
        • POSTCreate local runner job
        • GETGet local runner
        • DELDisconnect local runner
        • GETGet bridge command
        • GETGet local runner job
        • POSTLocal runner heartbeat
        • GETList local runner jobs
        • GETList local runners
        • POSTPoll next bridge commands
        • POSTNext local runner job
        • PATCHPatch runner checklist
        • PUTRegister local runner agents
        • POSTReport bridge command result
        • POSTReport local runner job result
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceRunners

Next local runner job

POST
/v1/private/local-runners/:runnerId/jobs/next
POST
/api/v1/private/local-runners/:runnerId/jobs/next
$curl -X POST http://localhost:5173/api/v1/private/local-runners/runnerId/jobs/next
1{
2  "id": "string",
3  "runner_id": "string",
4  "agent_name": "string",
5  "status": "pending",
6  "inputs": {},
7  "result": {},
8  "error": "string",
9  "project_id": "string",
10  "trace_id": "string",
11  "prompt_masks": {},
12  "blueprint_name": "string",
13  "metadata": {
14    "dataset_id": "string",
15    "dataset_version_id": "string",
16    "dataset_item_version_id": "string",
17    "dataset_item_id": "string"
18  },
19  "timeout": 1,
20  "created_at": "2024-01-15T09:30:00Z",
21  "started_at": "2024-01-15T09:30:00Z",
22  "completed_at": "2024-01-15T09:30:00Z",
23  "mask_id": "string"
24}

Long-poll for the next pending local runner job

Was this page helpful?
Previous

Patch runner checklist

Next
Built with

Path parameters

runnerIdstringRequiredformat: "uuid"

Response

Job available, or null if no pending jobs
idstringformat: "uuid"
runner_idstringformat: "uuid"
agent_namestring
statusenum
Allowed values:
inputsobject
resultobject
errorstring
project_idstringformat: "uuid"
trace_idstringformat: "uuid"
prompt_masksmap from strings to strings
Mask overlays to apply during agent execution, keyed by prompt id.
blueprint_namestringformat: "(?s)^\s*(\S.*\S|\S)\s*$"
metadataobject
timeoutinteger
created_atdatetime
started_atdatetime
completed_atdatetime
mask_idstringformat: "uuid"Deprecated

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

Errors

404
Not Found Error