List Agent Definitions

Return a paginated list of agent definitions. Filter by agent type, search by name or assistant ID, and pin a specific agent to the top of results.

GET https://api.futureagi.com/simulate/agent-definitions/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Query parameters

search string Optional

Case-insensitive search across agent name, contact number, description, and assistant ID.

limit integer Optional

Results per page. Defaults to 10.

page integer Optional

Page number, starting from 1. Defaults to 1.

agent_type string Optional

Filter by agent type. Values: "voice", "text".

agent_definition_id string Optional

Pins the specified agent definition as the first result on page 1.

Response

200 OK
count integer
Total matching agent definitions across all pages.
next string
URL of the next page, or null.
previous string
URL of the previous page, or null.
results array

Array of agent definition objects.

id string
UUID of the agent definition.
agent_name string
Display name.
agent_type string
voice or text.
contact_number string
Phone number with country code. null for text agents.
inbound boolean
Whether the agent handles inbound calls.
description string
Agent description.
assistant_id string
External assistant ID, or null.
provider string
Voice provider, or null for text agents.
language string
ISO 639-1 language code.
languages array
All supported language codes.
websocket_url string
WebSocket URL, or null.
websocket_headers object
WebSocket headers, or null.
workspace string
Workspace UUID, or null.
knowledge_base string
Linked knowledge base UUID.
organization string
Organization UUID.
created_at datetime
ISO 8601 creation timestamp.
updated_at datetime
ISO 8601 last-modified timestamp.
latest_version integer
Most recent version number.
latest_version_id string
UUID of the most recent version.
model string
AI model identifier, if set.
model_details object
Extended model configuration.

Errors

400 Bad Request Optional

Invalid query parameters.

401 Unauthorized Optional

Invalid or missing API credentials.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE