Inspiration
Your ready-made content: look it up, or ask for it to be generated again.
Look up ready-made content
Looks up your ready-made suggestion-set for one segment, use case and locale. The response holds either one set or none. Omit version for the newest one, or pass it to fetch an earlier version.
When there is nothing to return you get a 200 with an empty data array, never a 404 — whether the segment and use case are unknown, the segment is not set up for content, or the first generation has not finished yet. After calling POST /v1/inspiration, poll here until data is no longer empty. In practice the empty response is common only for a new tenant, before anything has been generated.
query Parameters
segment_idThe segment's id.
A UUID, lower-case and hyphenated. Identifiers minted by this API are UUIDv7, so sorting them as strings happens to order them by creation time — the listings rely on that, which is why they need no sort parameter. Do not depend on it yourself, and do not read a timestamp out of an id: ids from other systems may be a different version, and the guarantee is not part of this contract.
use_case_idThe use-case's id.
A UUID, lower-case and hyphenated. Identifiers minted by this API are UUIDv7, so sorting them as strings happens to order them by creation time — the listings rely on that, which is why they need no sort parameter. Do not depend on it yourself, and do not read a timestamp out of an id: ids from other systems may be a different version, and the guarantee is not part of this contract.
locale^[a-z]{2,3}(-[A-Z]{2… · requiredThe content locale to look up, matched exactly. Pass the locale your tenant generates in — en or de — not a regional variant: en-GB is accepted by the pattern but matches no stored content, so it returns an empty data array rather than an error.
A BCP 47 language tag. Content is generated and stored in one of two locales today, written as a bare language code with no region subtag: en or de. The pattern also admits a region subtag (en-GB) so that regional content can be added without a breaking change, but no such locale exists yet: a request naming one matches nothing, and no response carries one. Which locale your content is generated in comes from your tenant's settings; you do not choose it per request.
versionA specific version to fetch. Omit for the newest one.
expand^asset_urls(,asset_u…Pass asset_urls to include a ready-to-load URL for every image in the response. Leave it out and each image's url and url_expires_at come back null, to be filled in later from the image's ref with POST /v1/assets/urls. Because the URLs are short-lived, ask for them at the moment you need to show the images. Any other value is rejected with 422.
Look up ready-made content › Responses
The suggestion-set, or an empty list if there is none.
Pagination metadata. There is no total count and no page number — a listing is walked forwards with the cursor until next_cursor is null, and cannot be jumped into part-way.
Generate ready-made content again
Asks for the ready-made content for one segment and use case to be generated again, and returns straight away with 202 and no body. The locale comes from your tenant's settings. Asking again while generation is already running for the same segment and use case joins the run in progress rather than starting a second one, and the existing content stays readable until the new version is ready. An unknown segment, or one not set up for content, returns 404.
No run identifier comes back from this call: poll GET /v1/inspiration until the new version appears. To generate content from your own instructions instead, use POST /v1/generation-runs, which does return a run you can poll.
Generate ready-made content again › Request Body
segment_idA UUID, lower-case and hyphenated. Identifiers minted by this API are UUIDv7, so sorting them as strings happens to order them by creation time — the listings rely on that, which is why they need no sort parameter. Do not depend on it yourself, and do not read a timestamp out of an id: ids from other systems may be a different version, and the guarantee is not part of this contract.
use_case_idA UUID, lower-case and hyphenated. Identifiers minted by this API are UUIDv7, so sorting them as strings happens to order them by creation time — the listings rely on that, which is why they need no sort parameter. Do not depend on it yourself, and do not read a timestamp out of an id: ids from other systems may be a different version, and the guarantee is not part of this contract.
Generate ready-made content again › Responses
Accepted. Generation is now running, or was already running for this segment and use case.