How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opik Runners API

Local runner management endpoints

Opik Runners API is one of 39 APIs that Opik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Runners. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 16 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: http://localhost:5173/api, https://www.comet.com/opik/api.

18 operations 16 paths 21 schemas 1 DELETE6 GET1 PATCH9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://www.comet.com/opik/api/v1
License
Resource Areas
1

Paths & Operations 18

Across 16 paths, the API surfaces 18 operations — 1 DELETE, 6 GET, 1 PATCH, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Runners 18

Local runner management endpoints

GET
/v1/private/local-runners/jobs/{jobId}/logs
Get local runner job logs
getJobLogs 2 params → 200404
POST
/v1/private/local-runners/jobs/{jobId}/logs
Append local runner job logs
appendJobLogs 1 param body → 204400404
POST
/v1/private/local-runners/jobs/{jobId}/cancel
Cancel local runner job
cancelJob 1 param → 204404
POST
/v1/private/local-runners/{runnerId}/bridge/commands
Submit bridge command
createBridgeCommand 1 param body → 201404409429
POST
/v1/private/local-runners/jobs
Create local runner job
createJob body → 201404409
GET
/v1/private/local-runners/{runnerId}
Get local runner
getRunner 1 param → 200404
DELETE
/v1/private/local-runners/{runnerId}
Disconnect local runner
disconnectRunner 1 param → 204
GET
/v1/private/local-runners/{runnerId}/bridge/commands/{commandId}
Get bridge command
getBridgeCommand 4 params → 200404
GET
/v1/private/local-runners/jobs/{jobId}
Get local runner job
getJob 1 param → 200404
POST
/v1/private/local-runners/{runnerId}/heartbeats
Local runner heartbeat
heartbeat 1 param body → 200404410
GET
/v1/private/local-runners/{runnerId}/jobs
List local runner jobs
listJobs 4 params → 200404
GET
/v1/private/local-runners
List local runners
listRunners 4 params → 200404
POST
/v1/private/local-runners/{runnerId}/bridge/commands/next
Poll next bridge commands
nextBridgeCommands 1 param body → 200404
POST
/v1/private/local-runners/{runnerId}/jobs/next
Next local runner job
nextJob 1 param → 200404
PATCH
/v1/private/local-runners/{runnerId}/checklist
Patch runner checklist
patchChecklist 1 param body → 204404
PUT
/v1/private/local-runners/{runnerId}/agents
Register local runner agents
registerAgents 1 param body → 204400404
POST
/v1/private/local-runners/{runnerId}/bridge/commands/{commandId}/results
Report bridge command result
reportBridgeResult 2 params body → 204404409
POST
/v1/private/local-runners/jobs/{jobId}/results
Report local runner job result
reportJobResult 1 param body → 204400404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are LocalRunnerJob (17 properties), BridgeCommand (12 properties), LocalRunner (9 properties), CreateLocalRunnerJobRequest (7 properties). Each schema is shown below with its type and property counts.

LocalRunnerPage
object
4 properties
BridgeCommandSubmitResponse
object
1 property
JsonNode
object
Agent
object
7 properties
LocalRunnerJobMetadata
object
4 properties
ErrorMessage
object
3 properties
LocalRunnerHeartbeatRequest
object
1 property
BridgeCommandBatchResponse
object
1 property
LocalRunnerJob
object
17 properties
LocalRunnerHeartbeatResponse
object
1 property
BridgeCommandItem
object
5 properties
LocalRunnerJobPage
object
4 properties
Param
object
3 properties 2 required
BridgeCommandSubmitRequest
object
3 properties 2 required
LocalRunner
object
9 properties
LocalRunnerJobResultRequest
object
4 properties 1 required
CreateLocalRunnerJobRequest
object
7 properties 2 required
BridgeCommandNextRequest
object
1 property
BridgeCommand
object
12 properties
BridgeCommandResultRequest
object
4 properties 1 required
LocalRunnerLogEntry
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opik-runners-api-openapi.yml Raw ↑

Other APIs Opik publishes across the network.

Opik Agent Configs API
Opik AI Spend API
Opik Alerts API
Opik Annotation Queues API
Opik Assertion Results API
Opik Attachments API
Opik Automation rule evaluators API
Opik Chat Completions API
Opik Check API
Opik Dashboards API
Opik Datasets API
Opik Environments API
Where this information came from

This is an independent, third-party profile of Opik Runners API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.