Flows
Templates

List Template Runs

List this template's runs created through this API, newest first.

get/v1/flows/templates/{template_id}/runs

Path parameters

template_idstring required

The ID of the template, as shown in the ElevenLabs app or by GET /v1/flows/templates.

The ID of the template, as shown in the ElevenLabs app or by GET /v1/flows/templates.

Query parameters

cursorstring nullable

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

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

page_sizeinteger

How many runs to return per page.

How many runs to return per page.

version_idstring nullable

Only return runs of this template version id.

Only return runs of this template version id.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable required

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

has_moreboolean required

Whether more runs exist beyond this page.

Example response

{
  "has_more": true,
  "next_cursor": "MjAyNi0wNy0xN1QxMjowMDowMHxLeDJtUDdZNFdWcmc5a0UzTm5SYw",
  "runs": [
    {
      "id": "sess_JWr5N6X9ZTqf8jD2LmQb",
      "outputs": {
        "marketing_title": {
          "content": "Ride the wave.",
          "id": "Kx2mP7Y4WVrg9kE3NnRc",
          "status": "completed",
          "type": "string"
        },
        "product_demo": {
          "id": "QWr5N6X9ZTqf8jD2La3B",
          "status": "generating",
          "type": "video"
        },
        "product_still": {
          "content_mime_type": "image/png",
          "content_url": "https://storage.googleapis.com/generations/JWr5N6X9ZTqf8jD2LmQb",
          "id": "JWr5N6X9ZTqf8jD2LmQb",
          "status": "completed",
          "type": "image"
        }
      },
      "status": "generating",
      "template_id": "tmpl_abc123",
      "version_id": "ver_01hxyz"
    }
  ]
}

Changes

Changed in 1 of the 49 revisions of this API.1