AgentResponse

Data returned for Agent. Required fields are id, name, category, description, item.

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

URL-safe short handle

anyOf

• string
• null

string

categoryCategory (string)required

Resource type tag

type object

Subtype within category

anyOf

• string
• null

string

collection_id object

Parent collection ID

anyOf

• string
• null

string

folder_id object

Identifier of the containing folder.

anyOf

• string
• null

string

tags object

Classification labels

anyOf

• string[]
• null

Array [

string

]

descriptionDescription (string)required

markingsstring[]

Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

Default value: []

created_at object

Creation timestamp (Unix ms)

anyOf

• integer
• null

integer

updated_at object

Last update timestamp (Unix ms)

anyOf

• integer
• null

integer

owners object[]

Users and groups that own the resource.

Array [

idId (string)required

"user." | "group." | "public.all"

typeType (string)required

Possible values: [user, group, public]

display_nameDisplay Name (string)required

avatar_url object

anyOf

• string
• null

string

avatar_config object

anyOf

• object
• null

object

email object

anyOf

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

anyOf

• string
• null

string

Possible values: [owner, grant, admin]

input_modeInput Mode (string)

Possible values: [chat, event]

Default value: chat

modeMode (string)

Possible values: [react, workflow]

Default value: react

agent object

anyOf

• AgentNodeConfig
• null

instructionsInstructions (string)required

Agent system instructions

prompts object[]

Reusable Prompt references. Rendered in list order and joined with '\n\n' as the system prefix; inline instructions is appended as a suffix. Empty = inline instructions only.

Array [

prompt_idPrompt Id (string)required

variables object

{{var}} bindings for the referenced Prompt

anyOf

• object
• null

object

]

model_providerModel Provider (string)required

LLM provider name

modelModel (string)required

LLM model name

tools object[]

Available tools

Array [

anyOf

• string
• AgentResourceRef
• AgentToolConfig
• object

string

]

actors object[]

Array [

anyOf

• string
• AgentResourceRef
• AgentActorConfig
• object

string

]

roles object[]

Array [

anyOf

• string
• AgentResourceRef
• object

string

]

outputs object

anyOf

• object
• null

object

max_iterationsMax Iterations (integer)

Maximum iteration count

Default value: 50

max_input_tokens object

Maximum input-token budget for the system prompt and conversation history before each model call. The effective limit cannot exceed the selected model's context_window; null uses the D.Hub default.

anyOf

• integer
• null

integer

Possible values: >= 1

compaction object

Optional per-agent conversation compaction settings. Omit this field to use D.Hub defaults.

anyOf

• AgentCompaction
• null

enabledEnabled (boolean)

Whether conversation compaction is enabled for the agent.

Default value: true

trigger_ratioTrigger Ratio (number)

Fraction of the input-token budget that triggers compaction.

Possible values: > 0 and < 1

Default value: 0.8

target_ratioTarget Ratio (number)

Fraction of the input-token budget targeted after compaction. It must be lower than trigger_ratio.

Possible values: > 0 and < 1

Default value: 0.5

summary_max_tokensSummary Max Tokens (integer)

Maximum number of tokens allowed in the generated compaction summary. Minimum: 128. Maximum: 8192.

Possible values: >= 128 and <= 8192

Default value: 1024

options object

anyOf

• object
• null

object

reasoning_effort object

Default reasoning effort for this agent. A value supplied with an individual request takes precedence; null uses the selected model's default.

anyOf

• string
• null

string

Possible values: [low, medium, high, xhigh]

nodes object[]

Array [

idId (string)required

Unique node ID

typeType (string)required

Node type

Possible values: [start, end, llm, tool_call, actor_call, if_else, loop, parallel, human_input, error_handler, code, template, variable]

config objectrequired

Type-specific node configuration

anyOf

• StartNodeConfig
• EndNodeConfig
• LLMNodeConfig
• ToolCallNodeConfig
• ActorCallNodeConfig
• IfElseNodeConfig
• LoopNodeConfig
• ParallelNodeConfig
• HumanInputNodeConfig
• ErrorHandlerNodeConfig
• CodeNodeConfig
• TemplateNodeConfig
• VariableNodeConfig

variables object[]

Array [

nameName (string)required

typeType (string)required

Possible values: [string, number, boolean, object, array]

requiredRequired (boolean)

Default value: true

defaultDefault

descriptionDescription (string)

Default value:

]

metadata object

property name*any

Default value: {}

]

edges object[]

Array [

sourceSource (string)required

Source node ID

targetTarget (string)required

Target node ID

condition object

Condition expression (unconditional if omitted)

anyOf

• string
• null

string

]

tablesstring[]

Default value: []

templatesstring[]

Default value: []

conversations object[]

Array [

nameName (string)required

typeType (string)required

Possible values: [string, number, boolean, array, object]

descriptionDescription (string)required

defaultDefault

]

options object

anyOf

• object
• null

object

is_builtinIs Builtin (boolean)

Whether this is a platform-shipped built-in agent

Default value: false

itemItem (string)requireddeprecated

AgentResponse

{
  "id": "string",
  "name": "string",
  "alias": "string",
  "category": "string",
  "type": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "markings": [
    "string"
  ],
  "created_at": 0,
  "updated_at": 0,
  "owners": [
    {
      "id": "string",
      "type": "user",
      "display_name": "string",
      "avatar_url": "string",
      "avatar_config": {},
      "email": "user@example.com"
    }
  ],
  "my_share_scope": "owner",
  "input_mode": "chat",
  "mode": "react",
  "agent": {
    "instructions": "string",
    "prompts": [
      {
        "prompt_id": "string",
        "variables": {}
      }
    ],
    "model_provider": "string",
    "model": "string",
    "tools": [
      "string",
      {
        "id": "string",
        "name": "string"
      },
      {
        "name": "string",
        "description": "",
        "type": "python",
        "function": {
          "source": "string",
          "inputs": {},
          "outputs": {},
          "dependencies": [
            "string"
          ],
          "decorators": [
            {
              "decorator": "string",
              "name": "string",
              "arguments": {}
            }
          ]
        },
        "require_browser": false,
        "options": {}
      },
      {}
    ],
    "actors": [
      "string",
      {
        "id": "string",
        "name": "string"
      },
      {
        "name": "string",
        "description": "",
        "function": {
          "source": "string",
          "inputs": {},
          "outputs": {},
          "dependencies": [
            "string"
          ],
          "decorators": [
            {
              "decorator": "string",
              "name": "string",
              "arguments": {}
            }
          ]
        },
        "confirmation_policy": "confirm",
        "options": {}
      },
      {}
    ],
    "roles": [
      "string",
      {
        "id": "string",
        "name": "string"
      },
      {}
    ],
    "outputs": {},
    "max_iterations": 50,
    "max_input_tokens": 0,
    "compaction": {
      "enabled": true,
      "trigger_ratio": 0.8,
      "target_ratio": 0.5,
      "summary_max_tokens": 1024
    },
    "options": {},
    "reasoning_effort": "low"
  },
  "nodes": [
    {
      "id": "string",
      "type": "start",
      "config": {
        "variables": [
          {
            "name": "string",
            "type": "string",
            "required": true,
            "description": ""
          }
        ]
      },
      "metadata": {}
    }
  ],
  "edges": [
    {
      "source": "string",
      "target": "string",
      "condition": "string"
    }
  ],
  "tables": [
    "string"
  ],
  "templates": [
    "string"
  ],
  "conversations": [
    {
      "name": "string",
      "type": "string",
      "description": "string"
    }
  ],
  "options": {},
  "is_builtin": false
}