Hedra API | Characters › Initialize Character Generation

API Reference

characters

Methods

Initialize Character Generation -> { jobId }

post/v1/characters

Initialize character generation

Security

API Key Header

Example: X-API-Key: My API Key

Body parameters

aspectRatio?: "1:1" | "16:9" | "9:16"

URL of audio uploaded using the /v1/audio endpoint

audioSource?: "tts" | "audio"

tts for text to speech or audio

avatarImage?: string

URL of image uploaded via /v1/portrait

avatarImageInput?: { prompt, seed }

Image metadata

text?: string

text to convert to audio. Ignored if audio_source is not tts

voiceId?: string

Voice ID

voiceUrl?: string

URL of audio uploaded using the /v1/audio endpoint

Response fields

jobId: string

Request example

curl /api/v1/characters \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $X_API_KEY" \
    -d '{}'

200Example

{
  "jobId": "jobId"
}