GetRouterDocs
  • English

    • Create a video generation task

    Submit a video generation task for either text-to-video or image-to-video generation. Returns a task ID that can be used to query task status through the GET endpoint.

    POST /v1/video/generations

    Service root: https://getrouter.ai

    Protocol: Video task API

    Authentication: Authorization: Bearer YOUR_API_KEY

    Request body

    The request body is required. Media type: application/json

    Request fields

    FieldTypeRequiredDescription
    modelstringNoModel or style ID
    promptstringNoText prompt describing the video
    imagestringNoImage input (URL or Base64)
    durationnumberNoVideo duration in seconds
    widthintegerNoVideo width
    heightintegerNoVideo height
    fpsintegerNoVideo frame rate
    seedintegerNoRandom seed
    nintegerNoNumber of videos to generate
    response_formatstringNoResponse format
    userstringNoUser identifier
    metadataobjectNoAdditional parameters, such as negative_prompt, style, and quality_level

    Example request

    curl --request POST \
  --url https://getrouter.ai/v1/video/generations \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{}'

    Responses

    StatusDescription
    200Video generation task created successfully
    400Invalid request parameters

    Success response fields

    FieldTypeRequiredDescription
    task_idstringNoTask ID
    statusstringNoTask status

    Example response

    {
  "task_id": "TASK_ID",
  "status": "completed"
}

    For complete workflows and examples, read the Video Generation API Guide.

    This page is generated from the public Relay OpenAPI specification. Browse the complete specification in the API Explorer.