Skip to main content
PATCH
/
workspaces
/
{workspace_id}
/
agent
/
presets
/
{preset_id}
Error
A valid request URL is required to generate request examples
{
  "model_name": "<string>",
  "model_provider": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "instructions": "<string>",
  "catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "base_url": "<string>",
  "actions": [
    "<string>"
  ],
  "namespaces": [
    "<string>"
  ],
  "tool_approvals": {},
  "mcp_integrations": [
    "<string>"
  ],
  "agents": {
    "enabled": false,
    "subagents": [
      {
        "preset": "<string>",
        "preset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "preset_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "preset_version": 2,
        "name": "<string>",
        "description": "<string>",
        "max_turns": 2
      }
    ]
  },
  "retries": 3,
  "enable_thinking": true,
  "enable_internet_access": false,
  "description": "<string>",
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skills": [
    {
      "skill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "skill_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "skill_name": "<string>",
      "skill_version": 123
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
preset_id
string<uuid>
required
​
workspace_id
string<uuid>
required

Body

application/json

Payload for updating an existing agent preset.

​
name
string | null
Required string length: 1 - 120
​
slug
string | null
Required string length: 1 - 160
​
description
string | null
Maximum string length: 1000
​
instructions
string | null
​
model_name
string | null
Required string length: 1 - 120
​
model_provider
string | null
Required string length: 1 - 120
​
catalog_id
string<uuid> | null
​
base_url
string | null
Maximum string length: 500
​
output_type
Available options:
bool,
float,
int,
str,
list[bool],
list[float],
list[int],
list[str]
​
actions
string[] | null
​
namespaces
string[] | null
​
tool_approvals
Tool Approvals · object | null
​
mcp_integrations
string[] | null
​
agents
AgentSubagentsConfig · object | null

User-facing agents toggle and optional preset-backed subagents.

​
retries
integer | null
Required range: x >= 0
​
enable_thinking
boolean | null
​
enable_internet_access
boolean | null
​
skills
AgentPresetSkillBindingBase · object[] | null

Response

Successful Response

API model for reading agent presets.

​
model_name
string
required
Maximum string length: 120
​
model_provider
string
required
Maximum string length: 120
​
id
string<uuid>
required
​
workspace_id
string<uuid>
required
​
name
string
required
​
slug
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
instructions
string | null
​
catalog_id
string<uuid> | null
​
base_url
string | null
Maximum string length: 500
​
output_type
Available options:
bool,
float,
int,
str,
list[bool],
list[float],
list[int],
list[str]
​
actions
string[] | null
​
namespaces
string[] | null
​
tool_approvals
Tool Approvals · object | null
​
mcp_integrations
string[] | null
​
agents
AgentSubagentsConfig · object

User-facing agents toggle and optional preset-backed subagents.

​
retries
integer
default:3
Required range: x >= 0
​
enable_thinking
boolean
default:true
​
enable_internet_access
boolean
default:false
​
description
string | null
Maximum string length: 1000
​
current_version_id
string<uuid> | null
​
folder_id
string<uuid> | null
​
skills
AgentPresetSkillBindingRead · object[]