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

Local runner heartbeat

POST
/v1/private/local-runners/:runnerId/heartbeats
POST
/api/v1/private/local-runners/:runnerId/heartbeats
$curl -X POST http://localhost:5173/api/v1/private/local-runners/runnerId/heartbeats \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "cancelled_job_ids": [
3    "string"
4  ]
5}
Refresh local runner heartbeat
Was this page helpful?
Previous

List local runner jobs

Next
Built with

Path parameters

runnerIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
capabilitieslist of stringsOptional

Response

Heartbeat response
cancelled_job_idslist of strings

Errors

404
Not Found Error
410
Gone Error