Agents
List agents
Get the agent configurations for the workspace identified by {wId}.
get/api/v1/w/{wId}/assistant/agent_configurations
Path parameters
wIdstring required
ID of the workspace
Query parameters
view'all' | 'list' | 'workspace' | 'published' | 'global' | 'favorites'
The view to use when retrieving agents:
- all: Retrieves all non-private agents (default if not authenticated)
- list: Retrieves all active agents accessible to the user (default if authenticated)
- published: Retrieves all agents with published scope
- global: Retrieves all global agents
- favorites: Retrieves all agents marked as favorites by the user (only available to authenticated users)
withAuthors'true' | 'false'
When set to 'true', includes recent authors information for each agent
Response
Agent configurations for the workspace
Example response
{
"agentConfigurations": [
{
"id": 12345,
"sId": "7f3a9c2b1e",
"version": 2,
"versionCreatedAt": "2023-06-15T14:30:00Z",
"versionAuthorId": "0ec9852c2f",
"name": "Customer Support Agent",
"description": "An AI agent designed to handle customer support inquiries",
"instructions": "Always greet the customer politely and try to resolve their issue efficiently.",
"pictureUrl": "https://example.com/agent-images/support-agent.png",
"status": "active",
"scope": "workspace",
"userFavorite": true,
"model": {
"providerId": "openai",
"modelId": "gpt-4",
"temperature": 0.7
},
"actions": [],
"maxStepsPerRun": 10,
"templateId": "b4e2f1a9c7"
}
]
}