Get avatar video generation job

Returns the status of an avatar video job created via POST /v2/videos/avatar-generations.

When status is succeeded, the response includes a signed URL valid for 24 hours from each call — re-fetch to refresh an expired URL.

GEThttps://api.deutschlandgpt.de/v2/videos/avatar-generations/{id}

Example request

curl https://api.deutschlandgpt.de/v2/videos/avatar-generations/{id} \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

curl https://api.deutschlandgpt.de/v2/videos/avatar-generations/{id} \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/videos/avatar-generations/{id}",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/videos/avatar-generations/{id}",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

const response = await fetch('https://api.deutschlandgpt.de/v2/videos/avatar-generations/{id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

const response = await fetch('https://api.deutschlandgpt.de/v2/videos/avatar-generations/{id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

Parameters

idstring<uuid>required

Response

200application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "object": "avatar_video.generation_job",
  "status": "pending",
  "created": 0
}

{
  "id": "00000000-0000-0000-0000-000000000000",
  "object": "avatar_video.generation_job",
  "status": "pending",
  "created": 0
}

Current job status. Shape depends on status.

The response takes one of the following shapes:

status: pending

idstring<uuid>

objectstring

statusstring

createdinteger

status: succeeded

idstring<uuid>

objectstring

statusstring

createdinteger

completed_atinteger | null

dataobject | null

urlstring<uri>

expires_in_secondsinteger

usageobject

durationSecondsinteger | null

resolutionstring

aspectRatiostring

avatarIdstring

voiceIdstring

costInEuronumber | null

status: failed

idstring<uuid>

objectstring

statusstring

errorstring

createdinteger

completed_atinteger | null

Response codes

200

Current job status. Shape depends on status.

object | object | object

401

Unauthorized

404

Job not found in this workspace