Skip to main content
GET
Get a generation result

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Path Parameters

generation_id
string
required

The task id returned by the Grounded Generation API.

Response

Successful grounded generation task response

generation_id
string
required

Unique task id.

modality
enum<string>
required

The type of output this task generates.

Available options:
image,
video
status
enum<string>
required

Task state.

Available options:
queued,
running,
succeeded,
failed
created_at
integer
required

Unix timestamp in seconds when the task was created.

updated_at
integer
required

Unix timestamp in seconds when the task was last updated.

request_id
string

Unique identifier for the request.

output_url
string

Signed download URL for the output, present when status is succeeded. Requires no API key, and is valid for 7 days after the task was created.

references
object[]

The reference material used to generate the output.

search_results
object[]

The search results the references were selected from, grouped by query.

error
object

Failure reason, present when status is failed. Failed tasks are not billed.

usage
object

Metering for the task. Present only when status is succeeded.