Get Identity

Retrieve a list of existing voice identities.

HTTP Request

GET https://app.resemble.ai/api/v2/identity

Query Parameters

Parameter	Type	Description
search	Optional	A search term to filter identities by name
page	Optional	Page number for pagination. Defaults to 1 if not provided

HTTP Response

{
    "success": true,
    "items": [
        {
            "id": "<string>",
            "name": "<string>",
            "created_at": "2024-01-01T00:00:00.000Z",
            "updated_at": "2024-01-01T00:00:00.000Z"
        }
        // ... more identity objects
    ]
}

Response Fields

Field	Type	Description
success	boolean	Indicates whether the operation was successful
items	array	An array of identity objects
id	string	Unique identifier for the identity
name	string	The name of the identity
created_at	string	Timestamp of when the identity was created
updated_at	string	Timestamp of when the identity was last updated

Example

curl --request GET \
  --url 'https://app.resemble.ai/api/v2/identity?search=John&page=1' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-type: application/json'

Replace YOUR_API_KEY with your actual Resemble AI API key.

Pagination

The API returns paginated results. You can specify the page number using the page query parameter. Each page contains a fixed number of items (typically 20, but this may vary).

Notes

• The response is ordered by creation date, with the most recently created identities appearing first.
• If no identities match the search criteria or if there are no identities on the specified page, an empty items array will be returned.
• For performance reasons, there may be a limit to the total number of pages or results that can be retrieved. If you need to access a large number of identities, consider using more specific search terms or implementing a date-based filtering strategy.