ARargildotai

Render a Video by id

Changed on

Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.

post/videos/{id}/render

Request

  • Base URL
    https://api.argil.ai/v1
  • Auth
    API key in header x-api-key

Path parameters

idstring required

The id of the Video to render

Request body

callbackUrlstring uri

Optional HTTPS URL to receive a one-shot webhook notification when this specific render completes (success or fail). The callback is fired once and then discarded. Both this callback and workspace webhooks include renderCost (credits debited for this render) and renderCostRefunded (true when that debit was refunded, which is the usual case when the render fails).

Example request

{
  "callbackUrl": "https://example.com/hooks/argil-render"
}

Response

The video plus the credits debited for this render

idstring uuid
namestring
createdAtstring date-time
updatedAtstring date-time
statusstring

Can be either IDLE, GENERATING_AUDIO, GENERATING_VIDEO, DONE or FAILED.

durationnumber nullable

Total video duration in seconds. null when audio hasn't been generated yet.

videoUrlstring

The url of the final avatar rendering video, containing all the moments merged.

videoUrlSubtitledstring

The url of the final avatar rendering video with subtitles. Only available if subtitles are enabled.

previewUrlstring

Url to the embedable preview of the video. Can be watched from web browsers or integrated in other websites before launching the generation. For embedable mode, add ?embed=true to the url.

aspectRatio'16:9' | '9:16'

The aspect ratio of the video output: 16:9 or 9:16.

extrasobject

A dictionary of custom key-value pairs to extend the video metadata. Maximum of 5 key-value pairs of 256 characters allowed.

renderCostinteger required

Credits debited for this render. 0 when the bundle was free. Absent from GET /videos and GET /videos/{id}.

Changes

  • 5dd9d8e3d0e3Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added the non-success response with the status

  • 166231bcfa85Revision changes
    • info

      added the optional property to the response with the status