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

Get local runner

GET
/v1/private/local-runners/:runnerId
GET
/api/v1/private/local-runners/:runnerId
$curl http://localhost:5173/api/v1/private/local-runners/runnerId
1{
2 "id": "string",
3 "name": "string",
4 "project_id": "string",
5 "status": "pairing",
6 "connected_at": "2024-01-15T09:30:00Z",
7 "agents": [
8 {
9 "name": "string",
10 "description": "string",
11 "language": "string",
12 "executable": "string",
13 "source_file": "string",
14 "params": [
15 {
16 "name": "string",
17 "type": "string",
18 "presence": "required"
19 }
20 ],
21 "timeout": 1
22 }
23 ],
24 "capabilities": [
25 "string"
26 ],
27 "checklist": {},
28 "type": "connect"
29}
Get a single local runner with its registered agents
Was this page helpful?
Previous

Disconnect local runner

Next
Built with

Path parameters

runnerIdstringRequiredformat: "uuid"

Response

Runner details
idstringformat: "uuid"
namestring
project_idstringformat: "uuid"
statusenum
Allowed values:
connected_atdatetime
agentslist of objects
capabilitieslist of strings
checklistobject
typeenum
Allowed values:

Errors

404
Not Found Error