Skip to main content
POST
Create an Avatar

Authorizations

X-App-ID
string
header
required

Your Spatius App ID.

X-API-Key
string
header
required

The API key bound to the App ID.

Body

application/json
imageUrl
string<uri>
required

Public HTTP(S) URL of the source image. Validated asynchronously after the job is accepted.

name
string

Optional display name. When omitted, a name like Avatar-<job-id-prefix> is generated.

Response

The creation job was accepted and queued.

jobId
string<uuid>

ID of the accepted creation job. Poll it with GET /avatar-jobs/{jobId}.

status
enum<string>

Lifecycle status of an Avatar creation job.

Available options:
queued,
processing,
succeeded,
failed
createdAt
string<date-time>