Create workspace agent

POST/api/v1/agents

Creates an agent definition in the resolved workspace.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*nonEmptyString

a non empty string

Length1 <= length

handle*nonEmptyString

a non empty string

Length1 <= length

description?string|null

instructions?string|null

model?string|null

capabilities?

Response Body

`application/json`

curl -X POST "https://loading/api/v1/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "Support Assistant",    "handle": "support-assistant",    "description": "Handles customer support workflows and escalations.",    "instructions": "Answer with concise, actionable steps. Be decisive and ask only for missing details that materially change the outcome.",    "model": "openai/gpt-5.4",    "capabilities": {      "webAccess": true,      "browserAccess": true,      "objectsAccess": true,      "linkedCredentialIds": [        "wcred_01JQFQY7XMQJ0TA3A7X7F7WQ4H"      ]    }  }'

{
  "id": "0c65de2d-728a-4d72-9f4f-9f0d42cfc705",
  "name": "Support Assistant",
  "handle": "support-assistant",
  "url": "/w/acme-growth-team/agents/support-assistant-0c65de2d-728a-4d72-9f4f-9f0d42cfc705",
  "description": "Handles customer support workflows and escalations.",
  "instructions": "Answer with concise, actionable steps. Be decisive and ask only for missing details that materially change the outcome.",
  "model": "openai/gpt-5.4",
  "capabilities": {
    "webAccess": true,
    "browserAccess": true,
    "objectsAccess": true,
    "linkedCredentialIds": [
      "wcred_01JQFQY7XMQJ0TA3A7X7F7WQ4H"
    ]
  },
  "createdAt": "2026-03-11T02:00:00.000Z",
  "updatedAt": "2026-03-11T02:00:00.000Z"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have the required permission.",
  "details": {
    "requiredPermission": "resource.action"
  }
}

{
  "code": "conflict",
  "message": "The requested resource already exists."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Create workspace agent

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`