inspiration_jobs

GET /api/inspiration_jobs/

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.

Response

idstring uuid required
inspiration_idstring required

ID of the inspiration.

gen_typestring required

Generation type of the community recipe.

statusstring required

Current status of the generation job.

failed_reasonstring required

Reason for failure if the generation failed.

input_paramsstring required

Parameters for generation

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

outputstring required

List of generated assets.

created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before