Get local runner

GET

/v1/private/local-runners/:runnerId

GET

/api/v1/private/local-runners/:runnerId

1 import requests
2 
3 url = "http://localhost:5173/api/v1/private/local-runners/runnerId"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "name": "Local Runner Alpha",
4   "status": "connected",
5   "connected_at": "2024-01-15T09:30:00Z",
6   "agents": [
7     {
8       "name": "Data Processor Agent",
9       "project": "Image Classification",
10       "description": "Processes image data for classification tasks",
11       "language": "Python",
12       "executable": "python3",
13       "source_file": "process_images.py",
14       "params": [
15         {
16           "name": "batch_size",
17           "type": "integer"
18         }
19       ],
20       "timeout": 300
21     }
22   ]
23 }

Get a single local runner with its registered agents

Path parameters

runnerIdstringRequiredformat: "uuid"

Response

Runner details

idstring or nullformat: "uuid"

namestring or null

statusenum or null

Allowed values:

connected_atdatetime or null

agentslist of objects or null

Path parameters

Response

Errors