List Templates

List the published flows templates in your workspace, together with each runnable version's inputs and outputs. Use the ids here as `template_id` / `version_id` on `POST /v1/flows/templates/{template_id}/runs`. Versions built on models that are not available to you through the API are left out, so `versions` is empty when none of a template's published versions is runnable through this API. Templates shared with you by link, or published to Explore from another workspace, are not listed but can still be fetched and run by `template_id`.

Headers

xi-api-keystringOptional

Query parameters

cursorstring or nullOptional

Pagination cursor: the next_cursor value of the previous page’s response. Omit it for the first page.

page_sizeintegerOptional1-25Defaults to 10
How many templates to return per page. Lower than the run list's ceiling because each row expands its versions' input and output schemas.
versions_per_templateintegerOptional1-10Defaults to 3

How many of each template’s published versions to return, newest first. has_more_versions tells you when a template has more.

searchstring or nullOptional<=100 characters
Only return templates whose name or description contains this text.

Response

Successful Response
templateslist of objects

The templates on this page, most recently updated first. A page can hold fewer than page_size templates, or none at all, because templates you cannot run are filtered out after the page is read — keep paging while has_more is true.

next_cursorstring or null

Pass as cursor to fetch the next page. null when there is no further page.

has_morebooleanRead-only
Whether more templates exist beyond this page.

Errors

422
Unprocessable Entity Error