Register local runner agents | Opik Documentation

PUT/v1/private/local-runners/{runnerId}/agentsRegister local runner agents

Parameters

runnerIdstring · uuidpathrequired

Request body

Map of agent name to agent definition

application/json

object

Example request

{}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

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

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

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

Examples

runnerIdrequiredpath parameter

curl -X PUT 'http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/agents' \
  -H 'Content-Type: application/json' \
  -d '{}'

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/agents', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/agents', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/agents",
    headers={"Content-Type": "application/json"},
    data='{}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/agents", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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/agents");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$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/agents"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
    .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/agents")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{}"
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.Put, "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/agents");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

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

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