List local runners | Opik Documentation

GET/v1/private/local-runnersList local runners

List local runners owned by the current user in the workspace

Parameters

project_idstring · uuidqueryrequired

statusstringquery

one of "pairing", "connected", "disconnected"

pageinteger · int32query

default 0 · minimum 0

sizeinteger · int32query

default 25 · minimum 1

Responses

objectLocalRunnerPage

contentarray of object

Show child attributes

Show array items

agentsarray of object

Show child attributes

Show array items

descriptionstring

executablestring

languagestring

namestring

paramsarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

presencestring

one of "required", "optional"

typestringrequired

minLength 1

source_filestring

timeoutinteger · int32

capabilitiesarray of string

Show child attributes

checklistobject

connected_atstring · date-time

idstring · uuid

namestring

project_idstring · uuid

statusstring

one of "pairing", "connected", "disconnected"

typestring

one of "connect", "endpoint"

pageinteger · int32

sizeinteger · int32

totalinteger · int64

Example response

{
  "content": [
    {
      "agents": [
        {
          "description": "string",
          "executable": "string",
          "language": "string",
          "name": "string",
          "params": [
            {
              "name": "string",
              "presence": "optional",
              "type": "string"
            }
          ],
          "source_file": "string",
          "timeout": 0
        }
      ],
      "capabilities": [
        "string"
      ],
      "checklist": {},
      "connected_at": "2026-06-09T00:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "status": "connected",
      "type": "connect"
    }
  ],
  "page": 0,
  "size": 0,
  "total": 0
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

project_idrequiredquery parameter

statusquery parameter

pagequery parameter

sizequery parameter

curl -X GET 'http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected'

const response = await fetch('http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/local-runners?page=0&project_id=00000000-0000-0000-0000-000000000000&size=25&status=connected");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "agents": [
        {
          "description": "string",
          "executable": "string",
          "language": "string",
          "name": "string",
          "params": [
            {
              "name": "string",
              "presence": "optional",
              "type": "string"
            }
          ],
          "source_file": "string",
          "timeout": 0
        }
      ],
      "capabilities": [
        "string"
      ],
      "checklist": {},
      "connected_at": "2026-06-09T00:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "status": "connected",
      "type": "connect"
    }
  ],
  "page": 0,
  "size": 0,
  "total": 0
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}