Skip to main content
PATCH
/
api
/
v3
/
agents
/
{id}
Update an agent
curl --request PATCH \
  --url https://paradigm.lighton.ai/api/v3/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "scope_workspaces_by_group": true,
  "native_tool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "mcp_server_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "company": {
    "id": 123,
    "name": "<string>",
    "allow_ephemeral_mode": true,
    "is_sharing_enabled": true
  },
  "group": {
    "name": "<string>",
    "id": 123
  },
  "workspaces": [
    {
      "id": 123,
      "name": "<string>",
      "category": "<string>",
      "file_count": 123,
      "summaries": []
    }
  ],
  "tools": {
    "native": [
      {
        "id": "<string>",
        "name": "<string>",
        "object": "tool"
      }
    ],
    "mcp_servers": [
      {
        "id": "<string>",
        "name": "<string>",
        "object": "mcp_server"
      }
    ]
  },
  "is_default": true,
  "scope_workspaces_by_group": true,
  "is_current_user_favorite": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

ID of the agent to update

Body

name
string | null
description
string | null
instructions
string | null
scope_workspaces_by_group
boolean | null
native_tool_ids
string<uuid>[] | null
mcp_server_ids
string<uuid>[] | null

Response

id
integer
required
name
string
required
description
string | null
required
instructions
string | null
required
company
object
required
group
object
required
workspaces
object[]
required
tools
object
required
is_default
boolean
required
scope_workspaces_by_group
boolean
required
is_current_user_favorite
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required