Documentation

Jobs

Retrieve Raywake generation status and output links, or filter your job history by model, date, status and source through the API.

Get a job

GET/v1/jobs/{job_id}

Requires jobs:read. Only jobs of the key's account are visible.

curl -s https://api.raywake.com/v1/jobs/JOB_ID \
  -H "Authorization: Bearer $RAYWAKE_API_KEY"

Job fields
Name	Type	Description
`job_id`	string	Identifier for polling and support requests.
`status`	string	Lifecycle state. See Generations.
`model`	string	The model id the generation ran on.
`prompt`	string	The prompt, when the model takes one.
`input`	object	The input you submitted, as sent (model defaults are not filled in).
`outputs`	array	Results: `type` (`image`, `video`, `audio`), `url`, `mime_type` and an optional `thumbnail_url`. Empty until the result is stored.
`image_url`	string \| null	The first image output, for convenience.
`error`	string \| null	A readable reason when the generation did not produce a result.
`quote_id`	string \| null	The quote the generation was admitted with.
`credits`	integer \| null	Credits held while running, captured on success, released on failure.
`source`	string	`api` when an API key started the job, otherwise `studio`.
`api_key_id`	string \| null	The API key that started the job.
`created_at`	string	ISO 8601 timestamp, UTC.
`completed_at`	string \| null	ISO 8601 timestamp, UTC, once terminal.

GET/v1/jobs

Query parameters
Name	Type	Description
`status`	string	Only jobs in this status.
`model`	string	Only jobs on this model id.
`since`	string	ISO 8601 time; only jobs created at or after it.
`until`	string	ISO 8601 time; only jobs created before it.
`source`	string	Where jobs were started. One of: `api`, `studio`
`api_key_id`	string	Only jobs started with this API key.
`limit`	integer	Page size, up to 500. Default: `50`
`offset`	integer	Items to skip. Default: `0`