Get Agents
Local
https://localhost
Local
https://localhost
GET
/api/v1/agents
Request
Query Params
Header Params
Body Params application/x-www-form-urlencoded
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://localhost/api/v1/agents?workspace_uuid={{workspace_uuid}}&organization_multiplai_id=&page=&user_id=&user_ids=&user_ids.*=&user_multiplai_id=&user_multiplai_ids=&user_multiplai_ids.*=&visibility=&is_shared=&with=&sort_by=&sort_direction=&with_metrics=&with_command_room_task=&category_uuids=&category_uuids.*=&search=&template=&favorite=' \
--header 'Accept: application/json' \
--header 'X-Multiplai-Authorization;' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Customer Support Assistant",
"description": "An AI assistant specialized in handling customer support inquiries and providing helpful responses.",
"instruction": "You are a helpful customer support agent. Always be polite, empathetic, and provide clear solutions to customer problems.",
"profile_photo_url": "https://example.com/storage/agents/agent-123.jpg",
"profile_photo_config": {
"emoji": "string",
"background_color": "string",
"preference": "string"
},
"visibility": "public",
"metadata": {
"role": "Customer Support Specialist",
"goal_statement": "To provide exceptional customer service by quickly resolving issues and ensuring customer satisfaction.",
"backstory": "You have 5 years of experience in customer service and are known for your patience and problem-solving skills.",
"guardrails": "Never share personal customer information. Always escalate complex technical issues to human agents.",
"base_instructions": "Always greet customers warmly. Listen carefully to their concerns. Provide step-by-step solutions.",
"conversation_starters": [
"Hello! How can I help you today?",
"I'm here to assist you with any questions or concerns you may have.",
"What brings you here today? I'm ready to help!"
],
"greetings": "Welcome! I'm your friendly customer support assistant. How may I assist you today?",
"tone_of_voice": "Professional yet friendly, empathetic, and solution-focused. Use clear and simple language.",
"disc_personality": "dominant",
"openai_voice": "alloy",
"large_language_model": "gpt-4",
"memory": true,
"knowledge": true,
"web_search": false,
"property1": "string",
"property2": "string"
},
"is_owner": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"workflows_count": 0,
"tools_count": 0,
"threads_count": 0,
"last_used_at": "2019-08-24T14:15:22.123Z",
"usage_count": 0,
"usage_frequency": "hourly",
"user": {
"id": 123,
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
"multiplai_id": "multiplai_abc123def456",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"primary_workspace": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"slug": "my-ai-workspace",
"name": "My AI Workspace",
"profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
"multiplai_id": "multiplai_workspace_abc123",
"is_onboarded": true,
"metadata": {
"onboarding_step": 75,
"sources": [
"google_search",
"social_media",
"referral"
],
"affiliate_name": "John Doe Marketing",
"role": "Product Manager",
"industry": "Technology",
"tools": [
"slack",
"notion",
"github"
],
"ai_tools": {
"agents": [
{
"emoji": "🤖",
"name": "Customer Support Bot",
"description": "Handles customer inquiries and support tickets"
}
],
"prompts": [
{
"emoji": "✍️",
"name": "Email Writer",
"description": "Generates professional email responses"
}
],
"workflows": [
{
"emoji": "⚡",
"name": "Lead Processing",
"description": "Automatically processes and qualifies incoming leads"
}
]
},
"property1": "string",
"property2": "string"
},
"is_owner": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"user": {}
}
},
"workspace": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"slug": "my-ai-workspace",
"name": "My AI Workspace",
"profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
"multiplai_id": "multiplai_workspace_abc123",
"is_onboarded": true,
"metadata": {
"onboarding_step": 75,
"sources": [
"google_search",
"social_media",
"referral"
],
"affiliate_name": "John Doe Marketing",
"role": "Product Manager",
"industry": "Technology",
"tools": [
"slack",
"notion",
"github"
],
"ai_tools": {
"agents": [
{
"emoji": "🤖",
"name": "Customer Support Bot",
"description": "Handles customer inquiries and support tickets"
}
],
"prompts": [
{
"emoji": "✍️",
"name": "Email Writer",
"description": "Generates professional email responses"
}
],
"workflows": [
{
"emoji": "⚡",
"name": "Lead Processing",
"description": "Automatically processes and qualifies incoming leads"
}
]
},
"property1": "string",
"property2": "string"
},
"is_owner": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"user": {
"id": 123,
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
"multiplai_id": "multiplai_abc123def456",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"primary_workspace": {}
}
},
"tools": [
{
"uuid": "456e7890-e12b-34c5-d678-901234567890",
"name": "Email Sender",
"description": "Send emails through various providers",
"type": "api",
"profile_photo_url": "http://example.com",
"profile_photo_config": {},
"visibility": "public",
"credits": 0,
"is_owner": true,
"metadata": {},
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"pivot_account": {}
}
],
"workflows": [
{
"uuid": "abc12345-de67-89f0-1234-567890abcdef",
"name": "Customer Onboarding",
"description": "Automated workflow for onboarding new customers",
"profile_photo_url": "http://example.com",
"profile_photo_config": {},
"visibility": "public",
"is_active": true,
"is_owner": true,
"nodes": [
"string"
],
"edges": [
"string"
],
"settings": {},
"static_data": {},
"pin_data": {},
"trigger_count": 0,
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"deleted_at": "2019-08-24T14:15:22.123Z"
}
],
"shares": [
{
"entity_type": "user",
"entity": {
"id": 123,
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
"multiplai_id": "multiplai_abc123def456",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"primary_workspace": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"slug": "my-ai-workspace",
"name": "My AI Workspace",
"profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
"multiplai_id": "multiplai_workspace_abc123",
"is_onboarded": true,
"metadata": {
"onboarding_step": 75,
"sources": [
"google_search",
"social_media",
"referral"
],
"affiliate_name": "John Doe Marketing",
"role": "Product Manager",
"industry": "Technology",
"tools": [
"slack",
"notion",
"github"
],
"ai_tools": {
"agents": [
{
"emoji": "🤖",
"name": "Customer Support Bot",
"description": "Handles customer inquiries and support tickets"
}
],
"prompts": [
{
"emoji": "✍️",
"name": "Email Writer",
"description": "Generates professional email responses"
}
],
"workflows": [
{
"emoji": "⚡",
"name": "Lead Processing",
"description": "Automatically processes and qualifies incoming leads"
}
]
},
"property1": "string",
"property2": "string"
},
"is_owner": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:45:00Z",
"user": {}
}
},
"permission": "read"
}
]
}
]
}Modified at 2026-02-17 07:21:58