Get local runner | Opik Documentation

GET/v1/private/local-runners/{runnerId}Get local runner

Get a single local runner with its registered agents

Parameters

runnerIdstring · uuidpathrequired

Responses

objectLocalRunner

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"

Example response

{
  "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"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

runnerIdrequiredpath parameter

curl -X GET 'http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000'

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000")
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/00000000-0000-0000-0000-000000000000", 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/00000000-0000-0000-0000-000000000000");
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/00000000-0000-0000-0000-000000000000"))
    .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/00000000-0000-0000-0000-000000000000")
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/00000000-0000-0000-0000-000000000000");
using var response = await client.SendAsync(request);

{
  "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"
}

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