> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# テンプレート実行を一覧表示

GET https://api.elevenlabs.io/v1/flows/templates/{template_id}/runs

このAPIで作成されたこのテンプレートの実行を、作成日時の新しい順に一覧表示します。

Reference: https://elevenlabs.io/docs/api-reference/flows/templates/runs/list

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Path parameters

- `template_id` (string, required) — ElevenLabsアプリまたは`GET /v1/flows/templates`に表示されるテンプレートのID。

### Query parameters

- `cursor` (string, optional, nullable) — ページネーションカーソル：前のページのレスポンスに含まれる`next_cursor`値。最初のページでは省略します。
- `page_size` (integer, optional, default: 30) — 1ページあたりに返す実行数です。
- `version_id` (string, optional, nullable) — このテンプレートバージョンIDの実行のみを返します。

## Response

### 200

成功レスポンス。

- `runs` (list of TemplateRunResponse, required) — このページの実行。新しい順に並びます。各項目は`GET /v1/flows/templates/{template_id}/runs/{run_id}`と同じ形式です。
- `next_cursor` (string, required, nullable) — 次のページを取得するには`cursor`として渡します。次のページがない場合は`null`です。
- `has_more` (boolean, required) — このページ以降にさらに実行があるかどうか。

## Errors

### 422 Unprocessable Entity Error

検証エラー

- `detail` (list of ValidationError, optional)

## Types

### TemplateRunResponse

テンプレートの実行とその出力です。各出力は実行が作成された時点から存在し、それぞれの`status`を報告します。実行の`status`はそれらを集約し、`completed`または`failed`になると実行は完了します。

- `id` (string, required) — 実行の一意の識別子です。
- `template_id` (string, required) — この実行で使用されたテンプレート。複数のテンプレートを実行するWebhookコンシューマーは、実行とテンプレートの対応表を保持せずに各実行を区別できます。
- `version_id` (string, required) — この実行で使用されたテンプレートバージョン。実行の作成時に解決されるため、`latest`で開始した実行には実際に使用されたバージョンが記録されます。
- `status` (enum, required) — 出力から集約された実行のステータス。出力が開始するまでは`pending`、いずれかの出力が未完了の間は`generating`、すべての出力が完了すると`completed`、すべての出力が終了し少なくとも1つが失敗すると`failed`です。`completed`と`failed`は終端ステータスであり、実行がいずれかに到達すると`flows_template_run`Webhookが発火します。
  - Allowed values: `pending`, `generating`, `completed`, `failed`
- `outputs` (map from string to TemplateOutput, required) — 出力ポートIDをキーとする実行の出力。各出力は、ポートの`content_schema`の`type`に基づいて`type`で識別される`TemplateOutput`です。

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### TemplateOutput

テンプレート実行の出力の1つです。ポートの`content_schema`の`type`に基づいて、`type`で識別されます。 ライフサイクル上の状態は`status`で確認してください。

- `type`: `array` (TemplateArrayOutput)
  - `has_more` (boolean, required) — リストに`content`以外の要素があるかどうか。
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (list of TemplateOutput, optional, nullable) — リストの先頭要素です。順番どおりに並び、各要素はスキーマの`items`の形式に従います。`status`が`completed`の場合にのみ含まれます。`has_more`がtrueの場合、これはリスト全体ではありません。予約済み：現時点でこの種類の出力を生成するテンプレートはありませんが、対応するテンプレートを同じクライアントで実行できるよう公開されています。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
  - `next_cursor` (string, optional, nullable) — 後続のエンドポイントで`cursor`として渡すと、`content`より後の要素を取得できます。`content`にリスト全体が含まれる場合、または出力が完了する前は`null`です。予約済み：現時点でこの種の出力を生成するテンプレートはありませんが、生成するテンプレートが同じクライアントで実行できるよう公開されています。
- `type`: `audio` (TemplateAudioOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content_mime_type` (string, optional, nullable) — 生成されたメディアのMIMEタイプ。`status`が`completed`の場合にのみ存在します。
  - `content_url` (string, optional, nullable) — 生成されたメディアをダウンロードするための署名付きURLです。`status`が`completed`の場合にのみ含まれます。このレスポンスの返却から約1時間で有効期限が切れます。新しいURLを取得するには、実行を再度取得してください。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `boolean` (TemplateBooleanOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (boolean, optional, nullable) — 生成されたboolean値。`status`が`completed`の場合にのみ含まれます。予約済み：現時点でこの種類の出力を生成するテンプレートはありませんが、対応するテンプレートを同じクライアントで実行できるよう公開されています。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `image` (TemplateImageOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content_mime_type` (string, optional, nullable) — 生成されたメディアのMIMEタイプ。`status`が`completed`の場合にのみ存在します。
  - `content_url` (string, optional, nullable) — 生成されたメディアをダウンロードするための署名付きURLです。`status`が`completed`の場合にのみ含まれます。このレスポンスの返却から約1時間で有効期限が切れます。新しいURLを取得するには、実行を再度取得してください。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `integer` (TemplateIntegerOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (integer, optional, nullable) — 生成された整数。`status`が`completed`の場合にのみ含まれます。予約済み：現時点でこの種類の出力を生成するテンプレートはありませんが、対応するテンプレートを同じクライアントで実行できるよう公開されています。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `number` (TemplateNumberOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (double, optional, nullable) — 生成された数値。`status`が`completed`の場合にのみ含まれます。予約済み：現時点でこの種類の出力を生成するテンプレートはありませんが、対応するテンプレートを同じクライアントで実行できるよう公開されています。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `object` (TemplateObjectOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (map from string to TemplateOutput, optional, nullable) — フィールド名をキーとし、各フィールドのスキーマ形式に従うフィールドごとの出力です。`status`が`completed`の場合にのみ存在します。予約済み：この種類の出力を生成するテンプレートはまだありませんが、将来そのようなテンプレートを同じクライアントで実行できるよう公開されています。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `string` (TemplateStringOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (string, optional, nullable) — 生成されたテキスト。`status`が`completed`の場合にのみ含まれます。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `video` (TemplateVideoOutput)
  - `id` (string, required) — この出力を生成した生成結果のID。出力を別の場所で入力として使用するには、`generation`参照として渡します。
  - `status` (enum, required) — 出力のライフサイクルステータス。出力のコンテンツフィールドが設定されると`completed`、`failure_reason`と`error_message`が設定されると`failed`で終了します。
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content_mime_type` (string, optional, nullable) — 生成されたメディアのMIMEタイプ。`status`が`completed`の場合にのみ存在します。
  - `content_url` (string, optional, nullable) — 生成されたメディアをダウンロードするための署名付きURLです。`status`が`completed`の場合にのみ含まれます。このレスポンスの返却から約1時間で有効期限が切れます。新しいURLを取得するには、実行を再度取得してください。
  - `error_message` (string, optional, nullable) — 人間が読みやすい失敗の説明です。`status`が`failed`の場合にのみ含まれます。失敗した生成には課金されません。
  - `failure_reason` (enum, optional, nullable) — 失敗のカテゴリ。`status`が`failed`の場合にのみ存在します。
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`

### ValidationErrorLocItems

## Examples

**Response**

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

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/flows/templates/template_id/runs"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/flows/templates/template_id/runs';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/flows/templates/template_id/runs"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/flows/templates/template_id/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/flows/templates/template_id/runs")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/flows/templates/template_id/runs');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/flows/templates/template_id/runs");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/flows/templates/template_id/runs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```