VEED Avatars Text to Video

POST/v1/run

Avatars is VEED's text-to-video AI model. Turn written scripts and prompts into professional-quality video clips with realistic motion, lighting, and scene composition.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to veed/avatars/text-to-video.

Default: veed/avatars/text-to-video

Optional<string>text

Request parameter supported by this model.

Optional<string>avatar_id

The avatar to use for the video

Allowed values: emily_vertical_primary, emily_vertical_secondary, marcus_vertical_primary, marcus_vertical_secondary, mira_vertical_primary, mira_vertical_secondary, jasmine_vertical_primary, jasmine_vertical_secondary, jasmine_vertical_walking, aisha_vertical_walking, elena_vertical_primary, elena_vertical_secondary, any_male_vertical_primary, any_female_vertical_primary, any_male_vertical_secondary, any_female_vertical_secondary, any_female_vertical_walking, emily_primary, emily_side, marcus_primary, marcus_side, aisha_walking, elena_primary, elena_side, any_male_primary, any_female_primary, any_male_side, any_female_side

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: text-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async

# 1. Submit a generation request
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "veed/avatars/text-to-video",
  "text": "\nEver wondered how to get that flawless glow? \nIntroducing our new skincare line, designed for real life. \nStep one: Cleanse with our gentle, nourishing formula. \nStep two: Apply our hydrating serum for that dewy look. \nStep three: Lock it in with our lightweight moisturizer. \nFeel the difference with every application. \nSee the glow? That's the magic of our skincare. \nUse code 'GLOW20' for an exclusive discount. \nJoin the skincare revolution today!\n"
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "model": "veed/avatars/text-to-video",
  "status": "running"
}