CRcreatify
aurora

GET /api/aurora/

Changed on

Retrieve a list of records. Optionally filter by ids (UUIDs) and/or a creation time window [created_after, created_before). The window selects records by when they were created; status and credits_used reflect their current state and can change until the job finishes (failed jobs are refunded and report 0 credits).

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Query parameters

created_afterstring date-time

Only return records created at or after this time (inclusive). ISO 8601, e.g. 2026-09-27T00:00:00Z or 2026-09-27T00:00:00+08:00 (URL-encode '+' as %2B). Timestamps without an offset are treated as UTC.

created_beforestring date-time

Only return records created before this time (exclusive). Same format as created_after.

idsstring

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

limitinteger

Opt-in pagination: when set (1-100), the response is an object with count, next, previous and results instead of a plain array.

model_versionstring

Only return videos rendered with these model versions, comma-separated: 'aurora_v1', 'aurora_v1_fast', 'aurora_v2'.

offsetinteger

Index of the first result to return, used with limit.

orderingstring

Which field to use when ordering the results.

source'api'

'api' returns only videos created through the API. Without it the list also includes Aurora videos made in the Creatify web app.

  • api - api

Response

OR

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

  • 8423ba73b422Revision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • breaking

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

    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter model_version

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter source