Retrieve a single agent
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/agents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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>"{
"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
Retrieve a single agent
Get detailed information about a specific agent (ChatSettings) by ID. Access control: Sys-admin users can access all agents from all companies. Company admin users can access all agents from their company. Regular users can only access agents linked to groups they belong to.
GET
/
api
/
v3
/
agents
/
{id}
Retrieve a single agent
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/agents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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>"{
"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 retrieve
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