Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a Veo video task. Parameters are narrowed according to the current Tikway gateway capabilities; for differences between models, see operation description and x-model-capabilities.

model
enum<string>
required

Veo model ID.

Available options:
veo-3.1-fast,
veo-3.1-quality,
veo-3.1-lite
prompt
string
required

Video generation or editing prompt words.

Minimum string length: 1
duration

The current Tikway route generates a fixed 8-second video. Google native Veo 3.1 also supports 4 seconds and 6 seconds, but the gateway is not currently open.

aspect_ratio
enum<string>

Video aspect ratio. When producing videos, some models will automatically determine the proportions based on the input material.

Available options:
16:9,
9:16
resolution
enum<string>

Output resolution. Available values ​​for different models or modes are shown in the model capabilities table.

Available options:
720p,
1080p
frame_images
object[]

The first frame or the last frame reference picture; at most one of the same type.

Maximum array length: 2
input_references
object[]

Maximum 3 reference images. Veo 3.1 Lite does not support normal reference image mode; please use frame_images for the first and last frames.

Maximum array length: 3
callback_url
string<uri>

User task callback address. Called by Tikway after the task status changes, it is not directly passed to the model upstream.

Pattern: ^https://
extra_body
object

TTAPI Veo extension parameters. Usually no setting is required, the gateway will automatically select generation_type based on frame_images or input_references.

Response

202 - application/json

POST /v1/videos Response parameters after the video task is successfully created. The interface returns HTTP 202.

id
string
required

The unique identifier of the video generation task, used for subsequent query of task status.

Minimum string length: 1
Example:

"9552de3d-171f-4cca-b492-7baa56523239"

status
enum<string>
required

Task creation status. pending means that the task has been created and is waiting for submission; queue means that the task has entered the generation queue.

Available options:
pending,
queue
Example:

"queue"

polling_url
string<uri>
required

Video task query address, the client can poll the task status through GET request.

Pattern: ^https://
Example:

"https://api.example.com/v1/videos/9552de3d-171f-4cca-b492-7baa56523239"