Create local runner job | Opik Documentation

POST/v1/private/local-runners/jobsCreate local runner job

Create a local runner job and enqueue it for execution

Request body

application/json

objectCreateLocalRunnerJobRequest

agent_namestringrequired

minLength 1

blueprint_namestring

pattern (?s)^\s*(\S.*\S|\S)\s*$

inputsobject

mask_idstring · uuid

Deprecated. Use prompt_masks to pass one or more mask overlays keyed by prompt id.

metadataobject

Show child attributes

dataset_idstring · uuid

dataset_item_idstring · uuid

dataset_item_version_idstring · uuid

dataset_version_idstring · uuid

project_idstring · uuidrequired

prompt_masksobject

Mask overlays to apply during agent execution, keyed by prompt id.

Example request

{
  "agent_name": "string",
  "blueprint_name": "string",
  "inputs": {},
  "mask_id": "00000000-0000-0000-0000-000000000000",
  "metadata": {
    "dataset_id": "00000000-0000-0000-0000-000000000000",
    "dataset_item_id": "00000000-0000-0000-0000-000000000000",
    "dataset_item_version_id": "00000000-0000-0000-0000-000000000000",
    "dataset_version_id": "00000000-0000-0000-0000-000000000000"
  },
  "project_id": "00000000-0000-0000-0000-000000000000",
  "prompt_masks": {
    "additionalProp1": "00000000-0000-0000-0000-000000000000"
  }
}

Responses

Headers

Location

URI of the job

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

curl -X POST 'http://localhost:5173/api/v1/private/local-runners/jobs' \
  -H 'Content-Type: application/json' \
  -d '{"agent_name":"string","blueprint_name":"string","inputs":{},"mask_id":"00000000-0000-0000-0000-000000000000","metadata":{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_item_id":"00000000-0000-0000-0000-000000000000","dataset_item_version_id":"00000000-0000-0000-0000-000000000000","dataset_version_id":"00000000-0000-0000-0000-000000000000"},"project_id":"00000000-0000-0000-0000-000000000000","prompt_masks":{"additionalProp1":"00000000-0000-0000-0000-000000000000"}}'

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/jobs', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"agent_name":"string","blueprint_name":"string","inputs":{},"mask_id":"00000000-0000-0000-0000-000000000000","metadata":{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_item_id":"00000000-0000-0000-0000-000000000000","dataset_item_version_id":"00000000-0000-0000-0000-000000000000","dataset_version_id":"00000000-0000-0000-0000-000000000000"},"project_id":"00000000-0000-0000-0000-000000000000","prompt_masks":{"additionalProp1":"00000000-0000-0000-0000-000000000000"}}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/jobs', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"agent_name\":\"string\",\"blueprint_name\":\"string\",\"inputs\":{},\"mask_id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_version_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\"},\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"prompt_masks\":{\"additionalProp1\":\"00000000-0000-0000-0000-000000000000\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/local-runners/jobs",
    headers={"Content-Type": "application/json"},
    data='{"agent_name":"string","blueprint_name":"string","inputs":{},"mask_id":"00000000-0000-0000-0000-000000000000","metadata":{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_item_id":"00000000-0000-0000-0000-000000000000","dataset_item_version_id":"00000000-0000-0000-0000-000000000000","dataset_version_id":"00000000-0000-0000-0000-000000000000"},"project_id":"00000000-0000-0000-0000-000000000000","prompt_masks":{"additionalProp1":"00000000-0000-0000-0000-000000000000"}}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"agent_name":"string","blueprint_name":"string","inputs":{},"mask_id":"00000000-0000-0000-0000-000000000000","metadata":{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_item_id":"00000000-0000-0000-0000-000000000000","dataset_item_version_id":"00000000-0000-0000-0000-000000000000","dataset_version_id":"00000000-0000-0000-0000-000000000000"},"project_id":"00000000-0000-0000-0000-000000000000","prompt_masks":{"additionalProp1":"00000000-0000-0000-0000-000000000000"}}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/local-runners/jobs", 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/jobs");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"agent_name\":\"string\",\"blueprint_name\":\"string\",\"inputs\":{},\"mask_id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_version_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\"},\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"prompt_masks\":{\"additionalProp1\":\"00000000-0000-0000-0000-000000000000\"}}");
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/jobs"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"agent_name\":\"string\",\"blueprint_name\":\"string\",\"inputs\":{},\"mask_id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_version_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\"},\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"prompt_masks\":{\"additionalProp1\":\"00000000-0000-0000-0000-000000000000\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/local-runners/jobs")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"agent_name\":\"string\",\"blueprint_name\":\"string\",\"inputs\":{},\"mask_id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_version_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\"},\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"prompt_masks\":{\"additionalProp1\":\"00000000-0000-0000-0000-000000000000\"}}"
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.Post, "http://localhost:5173/api/v1/private/local-runners/jobs");
request.Content = new StringContent("{\"agent_name\":\"string\",\"blueprint_name\":\"string\",\"inputs\":{},\"mask_id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_item_version_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\"},\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"prompt_masks\":{\"additionalProp1\":\"00000000-0000-0000-0000-000000000000\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 201)

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

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