Get Processor

GET

api

agent-studio

processors

{processor_id}

Get Processor

import requests

url = "https://www.datalab.to/api/v1/agent-studio/processors/{processor_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.datalab.to/api/v1/agent-studio/processors/{processor_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.datalab.to/api/v1/agent-studio/processors/{processor_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "origin": "platform",
  "base_profile": "<string>",
  "output_shape": "<string>",
  "latest_version": {
    "label": "<string>",
    "state": "draft",
    "contract": {
      "goal": "<string>",
      "output_shape": "parse",
      "output_schema": "<string>",
      "rules": [
        {
          "id": "<string>",
          "text": "<string>",
          "source": "user"
        }
      ],
      "parse_params": {},
      "knobs": {
        "max_turns": 2,
        "timeout_s": 2,
        "model": "<string>"
      }
    },
    "checks": [
      {
        "id": "<string>",
        "label": "<string>",
        "kind": "code",
        "description": "",
        "blocking": false,
        "source": "base",
        "modified_from_base": true
      }
    ],
    "caused_by": {},
    "created": "2023-11-07T05:31:56Z"
  },
  "published_version": "<string>",
  "run_count": 0,
  "execution_run_count": 0,
  "design_run_count": 0,
  "pass_rate": 0.5,
  "open_flag_count": 0,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "versions": [
    {
      "label": "<string>",
      "state": "draft",
      "contract": {
        "goal": "<string>",
        "output_shape": "parse",
        "output_schema": "<string>",
        "rules": [
          {
            "id": "<string>",
            "text": "<string>",
            "source": "user"
          }
        ],
        "parse_params": {},
        "knobs": {
          "max_turns": 2,
          "timeout_s": 2,
          "model": "<string>"
        }
      },
      "checks": [
        {
          "id": "<string>",
          "label": "<string>",
          "kind": "code",
          "description": "",
          "blocking": false,
          "source": "base",
          "modified_from_base": true
        }
      ],
      "caused_by": {},
      "created": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

processor_id

string

required

Cookies

wos-session

string

datalab_active_team

string

Response

Successful Response

string

required

Public processor id (slug) used in processor=@.

name

string

required

description

string

required

origin

enum<string>

required

Available options:

platform,

team

base_profile

string | null

output_shape

string | null

Output shape of the latest version, if any.

latest_version

VersionResponse · object | null

Show child attributes

published_version

string | null

Label of the newest published version, if any.

run_count

integer

default:0

The caller team's total run count across BOTH planes (kept as the pre-split total for compatibility).

execution_run_count

integer

default:0

The caller team's execution-plane run count.

design_run_count

integer

default:0

The caller team's design-plane run count.

pass_rate

number | null

Fraction of the caller team's terminal execution-plane runs that passed, over the newest 50 terminal execution runs (the window matches the UI's hydrated runs page). A run passes when its status is 'done' — by the error taxonomy a finished run with a failing BLOCKING check terminalizes as a contract error, so 'done' means every blocking check passed. None (never fabricated) when the team has no terminal execution runs.

Required range: 0 <= x <= 1

open_flag_count

integer

default:0

created

string<date-time> | null

updated

string<date-time> | null

versions

VersionResponse · object[]

Show child attributes

Get Processor

import requests

url = "https://www.datalab.to/api/v1/agent-studio/processors/{processor_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://www.datalab.to/api/v1/agent-studio/processors/{processor_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.datalab.to/api/v1/agent-studio/processors/{processor_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "origin": "platform",
  "base_profile": "<string>",
  "output_shape": "<string>",
  "latest_version": {
    "label": "<string>",
    "state": "draft",
    "contract": {
      "goal": "<string>",
      "output_shape": "parse",
      "output_schema": "<string>",
      "rules": [
        {
          "id": "<string>",
          "text": "<string>",
          "source": "user"
        }
      ],
      "parse_params": {},
      "knobs": {
        "max_turns": 2,
        "timeout_s": 2,
        "model": "<string>"
      }
    },
    "checks": [
      {
        "id": "<string>",
        "label": "<string>",
        "kind": "code",
        "description": "",
        "blocking": false,
        "source": "base",
        "modified_from_base": true
      }
    ],
    "caused_by": {},
    "created": "2023-11-07T05:31:56Z"
  },
  "published_version": "<string>",
  "run_count": 0,
  "execution_run_count": 0,
  "design_run_count": 0,
  "pass_rate": 0.5,
  "open_flag_count": 0,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "versions": [
    {
      "label": "<string>",
      "state": "draft",
      "contract": {
        "goal": "<string>",
        "output_shape": "parse",
        "output_schema": "<string>",
        "rules": [
          {
            "id": "<string>",
            "text": "<string>",
            "source": "user"
          }
        ],
        "parse_params": {},
        "knobs": {
          "max_turns": 2,
          "timeout_s": 2,
          "model": "<string>"
        }
      },
      "checks": [
        {
          "id": "<string>",
          "label": "<string>",
          "kind": "code",
          "description": "",
          "blocking": false,
          "source": "base",
          "modified_from_base": true
        }
      ],
      "caused_by": {},
      "created": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

compliance

API Reference

Custom Processors

Processor Templates

Custom Pipelines (Deprecated)

Pipeline Templates (Deprecated)

files

eval_rubrics

collections

pipelines

agent-studio

extraction_schemas

Authorizations

Path Parameters

Cookies

Response