Get the Single Agent Draft

GET

/api/app/{app_slug}/single-agent/

const url = 'https://api.agentaab.com/api/app/example/single-agent/';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.agentaab.com/api/app/example/single-agent/ \
  --header 'Authorization: <Authorization>'

Return the authoritative Single Agent v1 Definition, opaque Draft Revision, version summaries, and an explicit non-persisted migration marker when legacy configuration was adapted in memory.

Authorizations

tokenAuth
cookieAuth

Parameters

Path Parameters

app_slug

required

string

Responses

200

The editable Single Agent Draft.

application/json

object

required

string

application

required

string

definition

required

Complete authoritative editable Definition for one Single Agent. Raw secret-like fields and values are rejected recursively.

object

kind

required

string

Allowed values: single_agent

version

required

integer

Allowed values: 1

interaction_mode

required

string

Allowed values: completion chat

instructions

required

object

system

required

string

<= 32000 characters

user_template

required

string

>= 1 characters <= 64000 characters

model

required

object

provider

required

string

>= 1 characters <= 100 characters

model

required

string

>= 1 characters <= 200 characters

credential_ref

string

/^[A-Z][A-Z0-9_]{2,127}$/

api_base

Optional absolute HTTPS provider endpoint without userinfo or secret query parameters.

string format: uri

temperature

required

number

<= 2

top_p

required

number

<= 1

frequency_penalty

required

number

>= -2 <= 2

presence_penalty

required

number

>= -2 <= 2

tools

required

Array<object>

<= 32 items

A pinned Tool identity and optional server-managed credential reference. Raw credential values are forbidden.

object

required

string

kind

required

string

Allowed values: mcp function

version

required

string

tool_name

required

string

endpoint

Exact absolute HTTPS endpoint. Required for MCP Tools.

string format: uri

credential_ref

Name of a server-side Worker secret binding, never a credential value.

string

/^[A-Z][A-Z0-9_]{2,127}$/

credential_mode

string

Allowed values: bearer x_api_key

input_schema

required

JSON Schema with an object root.

object

key

additional properties

any

output_schema

required

JSON Schema with an object root.

object

key

additional properties

any

limits

required

object

timeout_ms

required

integer

>= 1000 <= 120000

max_output_tokens

required

integer

>= 1 <= 32768

max_tool_calls

required

integer

<= 32

configuration

required

object

key

additional properties

any

draft_revision

required

Opaque compare-and-set token; clients must not derive or modify it.

string

versions

required

Array<object>

object

required

string

version_number

required

integer

>= 1

is_active

required

boolean

changelog

string

created_at

required

string format: date-time

definition

Complete authoritative editable Definition for one Single Agent. Raw secret-like fields and values are rejected recursively.

object

kind

required

string

Allowed values: single_agent

version

required

integer

Allowed values: 1

interaction_mode

required

string

Allowed values: completion chat

instructions

required

object

system

required

string

<= 32000 characters

user_template

required

string

>= 1 characters <= 64000 characters

model

required

object

provider

required

string

>= 1 characters <= 100 characters

model

required

string

>= 1 characters <= 200 characters

credential_ref

string

/^[A-Z][A-Z0-9_]{2,127}$/

api_base

Optional absolute HTTPS provider endpoint without userinfo or secret query parameters.

string format: uri

temperature

required

number

<= 2

top_p

required

number

<= 1

frequency_penalty

required

number

>= -2 <= 2

presence_penalty

required

number

>= -2 <= 2

tools

required

Array<object>

<= 32 items

A pinned Tool identity and optional server-managed credential reference. Raw credential values are forbidden.

object

required

string

kind

required

string

Allowed values: mcp function

version

required

string

tool_name

required

string

endpoint

Exact absolute HTTPS endpoint. Required for MCP Tools.

string format: uri

credential_ref

Name of a server-side Worker secret binding, never a credential value.

string

/^[A-Z][A-Z0-9_]{2,127}$/

credential_mode

string

Allowed values: bearer x_api_key

input_schema

required

JSON Schema with an object root.

object

key

additional properties

any

output_schema

required

JSON Schema with an object root.

object

key

additional properties

any

limits

required

object

timeout_ms

required

integer

>= 1000 <= 120000

max_output_tokens

required

integer

>= 1 <= 32768

max_tool_calls

required

integer

<= 32

configuration

required

object

key

additional properties

any

active_version

required

object

required

string

version_number

required

integer

>= 1

is_active

required

boolean

changelog

string

created_at

required

string format: date-time

definition

Complete authoritative editable Definition for one Single Agent. Raw secret-like fields and values are rejected recursively.

object

kind

required

string

Allowed values: single_agent

version

required

integer

Allowed values: 1

interaction_mode

required

string

Allowed values: completion chat

instructions

required

object

system

required

string

<= 32000 characters

user_template

required

string

>= 1 characters <= 64000 characters

model

required

object

provider

required

string

>= 1 characters <= 100 characters

model

required

string

>= 1 characters <= 200 characters

credential_ref

string

/^[A-Z][A-Z0-9_]{2,127}$/

api_base

Optional absolute HTTPS provider endpoint without userinfo or secret query parameters.

string format: uri

temperature

required

number

<= 2

top_p

required

number

<= 1

frequency_penalty

required

number

>= -2 <= 2

presence_penalty

required

number

>= -2 <= 2

tools

required

Array<object>

<= 32 items

A pinned Tool identity and optional server-managed credential reference. Raw credential values are forbidden.

object

required

string

kind

required

string

Allowed values: mcp function

version

required

string

tool_name

required

string

endpoint

Exact absolute HTTPS endpoint. Required for MCP Tools.

string format: uri

credential_ref

Name of a server-side Worker secret binding, never a credential value.

string

/^[A-Z][A-Z0-9_]{2,127}$/

credential_mode

string

Allowed values: bearer x_api_key

input_schema

required

JSON Schema with an object root.

object

key

additional properties

any

output_schema

required

JSON Schema with an object root.

object

key

additional properties

any

limits

required

object

timeout_ms

required

integer

>= 1000 <= 120000

max_output_tokens

required

integer

>= 1 <= 32768

max_tool_calls

required

integer

<= 32

configuration

required

object

key

additional properties

any

migration

object

source

required

string

Allowed values: legacy_prompt

persisted

required

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "definition": {
    "kind": "single_agent",
    "version": 1,
    "interaction_mode": "completion",
    "tools": [
      {
        "kind": "mcp",
        "credential_mode": "bearer"
      }
    ]
  },
  "versions": [
    {
      "definition": {
        "kind": "single_agent",
        "version": 1,
        "interaction_mode": "completion",
        "tools": [
          {
            "kind": "mcp",
            "credential_mode": "bearer"
          }
        ]
      }
    }
  ],
  "active_version": {
    "definition": {
      "kind": "single_agent",
      "version": 1,
      "interaction_mode": "completion",
      "tools": [
        {
          "kind": "mcp",
          "credential_mode": "bearer"
        }
      ]
    }
  },
  "migration": {
    "source": "legacy_prompt",
    "persisted": false
  }
}

404

The Agent Business is missing, inaccessible, or is not a Single Agent.

application/json

object

error

required

string

code

string

draft_revision

string

issues

Array<object>

object

code

required

string

path

required

string

message

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "draft_revision": "example",
  "issues": [
    {
      "code": "example",
      "path": "example",
      "message": "example"
    }
  ]
}

Get the Single Agent Draft

Authorizations

Parameters

Path Parameters

Responses

200

Example

404

Examplegenerated

Example^generated