Create Identity

HTTP Request

POST https://app.0xIQ.ai/api/v2/identity

Request

Parameter
Type
Description

name

Required

A name or identifier for the voice identity. This should be a unique string to identify the voice profile.

url

Required

The URL of the audio file to create the identity from. Provide a valid HTTPS URL pointing to the audio file.

HTTP Response

{
    "success": true,
    "item": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
    }
}

Response Fields

Field
Type
Description

success

boolean

Indicates whether the operation was successful

item

object

Contains details about the created identity

id

string

Unique identifier for the created identity

name

string

The name provided for 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 POST \
  --url https://app.resemble.ai/api/v2/identity \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-type: application/json' \
  --data '{
  "name": "John Doe",
  "url": "https://example.com/audio/john_doe_sample.wav"
}'

Replace YOUR_API_KEY with your actual Resemble AI API key.

Error Handling

If the request is unsuccessful, you will receive an error response. For example:

{
    "success": false,
    "error": "Invalid audio file format. Please provide a WAV file."
}

Ensure that you provide a valid name and URL, and that the audio file is in a supported format (WAV is recommended).

Last updated