List personas

Retrieves a paginated list of personas, including system-level and workspace-level personas, with optional filtering by type, search, and simulation type.

GET https://api.futureagi.com/simulate/api/personas/

Authentication

X-Api-Key string 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 string 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

type string Optional

Filter personas by their origin type. Accepted values: prebuilt (returns system-level personas that are pre-configured and available to all workspaces) or custom (returns workspace-level personas that were created by your team). When omitted, both types are returned.

search string Optional

A case-insensitive search query that matches against the persona’s name, description, and keywords. For example, searching "skeptical" returns personas named "Skeptical Customer", personas with "skeptical" in their description, etc.

simulation_type string Optional

Filter personas by the type of simulation they are designed for. Accepted values: voice (returns personas configured for voice call simulations) or text (returns personas configured for text-based simulations). When omitted, personas of both simulation types are returned.

limit integer Optional

The number of personas to return per page. Defaults to 10. Use this in combination with page to paginate through large result sets.

page integer Optional

The page number to retrieve, starting from 1. Defaults to 1. Use in conjunction with limit to navigate through paginated results.

Response

200 OK
count integer

The total number of personas matching the applied filters across all pages. Use this value to calculate the total number of pages in combination with the limit parameter.

next string

The full URL of the next page of results. Returns null if the current page is the last page.

previous string

The full URL of the previous page of results. Returns null if the current page is the first page.

total_pages integer

The total number of pages available based on the current limit setting and the total count of matching personas.

current_page integer

The current page number being returned in this response.

results array of object

An array of persona objects for the current page.

id string

The unique identifier (UUID) of the persona.

name string

The display name of the persona.

description string

A text description of the persona’s characteristics and behavior.

persona_type string

The origin type of the persona: system (pre-configured, available to all workspaces) or workspace (custom, created by your team).

persona_type_display string

A human-readable label for the persona type (e.g., “Prebuilt” or “Custom”).

gender array

An array of gender attributes assigned to the persona.

age_group array

An array of age group ranges assigned to the persona.

occupation array

An array of occupation descriptors assigned to the persona.

location array

An array of location descriptors assigned to the persona.

personality array

An array of personality trait descriptors for the persona.

communication_style array

An array of communication style descriptors for the persona.

simulation_type string

The type of simulation the persona is designed for: voice or text.

is_default boolean

Whether this is a default persona that is automatically selected when no specific persona is chosen.

created_at string

ISO 8601 timestamp of when the persona was created.

updated_at string

ISO 8601 timestamp of the most recent modification to the persona.

Errors

401 Unauthorized Optional

Authentication credentials were not provided or are invalid. Ensure that both X-Api-Key and X-Secret-Key headers are included in your request and contain valid, non-expired keys. Verify your API keys in the Dashboard under Settings.

500 Internal Server Error Optional

An unexpected error occurred on the server while processing the request. This is not caused by your input. If this error persists, contact Future AGI support with the request details and timestamp for investigation.

GET /
Authentication
REQUEST
 
RESPONSE