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"
],
"scoped_workspace_ids": [
123
],
"ml_model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ml_model_alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/agents/{id}"
payload = {
"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"],
"scoped_workspace_ids": [123],
"ml_model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ml_model_alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'],
scoped_workspace_ids: [123],
ml_model: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ml_model_alias: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://paradigm.lighton.ai/api/v3/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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,
"ownership": "<string>",
"scope_workspaces_by_group": true,
"scoped_workspace_ids": [
123
],
"ml_model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ml_model_alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_current_user_favorite": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}"<unknown>""<unknown>""<unknown>"{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Agents
Update an agent
Partially update an agent (ChatSettings) by ID.
Access control:
- Users can update agents in their personal groups
- Company admins can update agents in any group within their company
- Sys-admin users can update any agent
Model configuration:
ml_modelandml_model_aliasare mutually exclusive — provide one or neither, not both- Setting one automatically clears the other
- Explicitly sending
nullclears the field (agent falls back to company default) - Omitting the field leaves the current value unchanged
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"
],
"scoped_workspace_ids": [
123
],
"ml_model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ml_model_alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/agents/{id}"
payload = {
"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"],
"scoped_workspace_ids": [123],
"ml_model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ml_model_alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'],
scoped_workspace_ids: [123],
ml_model: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ml_model_alias: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://paradigm.lighton.ai/api/v3/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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,
"ownership": "<string>",
"scope_workspaces_by_group": true,
"scoped_workspace_ids": [
123
],
"ml_model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ml_model_alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_current_user_favorite": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}"<unknown>""<unknown>""<unknown>"{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the agent to update
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes