> 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.

# Criar execução de modelo

POST https://api.elevenlabs.io/v1/flows/templates/{template_id}/runs
Content-Type: application/json

Inicia uma execução de um modelo de flows. Informe `version_id` para fixar um snapshot ou omita-o / informe `latest` para executar a versão publicada mais recente. Defina os valores de entrada em `inputs`, usando o ID da porta de entrada como chave. A resposta é a execução em seu estado inicial, com cada saída já listada em `outputs` sob o ID da respectiva porta. Inclua `webhook` para receber um evento `flows_template_run` com a execução concluída assim que seu `status` for `completed` ou `failed`; essa é a forma recomendada de aguardar. Sem isso, consulte `GET /v1/flows/templates/{template_id}/runs/{run_id}` em intervalos moderados até que o `status` seja terminal.

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

## 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) — O ID do modelo, conforme exibido no app da ElevenLabs ou por `GET /v1/flows/templates`.

### Body (application/json)

This endpoint expects a TemplateRunCreateRequest.

- `inputs` (map from string to TemplateRunInput, required) — Valores de entrada indexados pelo ID da porta de entrada. Todas as portas de entrada da versão em execução devem ser informadas; um ID ausente ou desconhecido será rejeitado. Passe `{}` para um template sem entradas.
- `version_id` (string, optional, nullable) — O snapshot do modelo a ser executado. Passe um ID de versão específico para fixar esse snapshot ou `latest` (o padrão quando omitido) para executar a versão publicada mais recentemente do modelo. Apenas versões publicadas podem ser fixadas, exceto pelo proprietário do modelo, que também pode fixar um snapshot salvo e não publicado para testá-lo antes da publicação. O rascunho ativo nunca é executado por esta API.
- `webhook` (WebhookTarget, optional, nullable) — Inclua para enviar o resultado da execução aos webhooks de fluxos configurados no workspace quando o `status` da execução atingir `completed` ou `failed`. Há um evento para toda a execução: os `data` do evento `flows_template_run` correspondem à resposta final de `GET /v1/flows/templates/{template_id}/runs/{run_id}`.

## Response

### 200

Resposta bem-sucedida

- `id` (string, required) — O identificador exclusivo da execução.
- `template_id` (string, required) — O modelo executado por esta execução, para que um consumidor de webhook que executa vários modelos possa diferenciar suas execuções sem manter um mapeamento entre execuções e modelos.
- `version_id` (string, required) — A versão do modelo executada por esta execução. Ela é definida quando a execução é criada; portanto, uma execução iniciada com `latest` registra a versão específica executada.
- `status` (enum, required) — O status da execução, consolidado a partir de suas saídas: `pending` até uma saída iniciar, `generating` enquanto alguma saída estiver inacabada, `completed` quando todas as saídas forem concluídas e `failed` quando todas as saídas terminarem e pelo menos uma falhar. `completed` e `failed` são terminais: o webhook `flows_template_run` é acionado quando a execução atinge um deles.
  - Allowed values: `pending`, `generating`, `completed`, `failed`
- `outputs` (map from string to TemplateOutput, required) — As saídas da execução, indexadas pelo ID da porta de saída. Cada uma é um `TemplateOutput` discriminado por `type`, o `type` do `content_schema` de sua porta.

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### TemplateRunInput

Um valor vinculado a uma porta de entrada de modelo, no formato exigido pelo seu `content_schema`. Uma porta `string` recebe o próprio texto; portas `number`, `integer` e `boolean` recebem um valor JSON desse tipo. Qualquer item armazenado em outro lugar é uma referência diferenciada por `type`: uma `generation` anterior, um `asset` enviado, uma `voice` ou mídia fornecida em `inline_base64`. Uma porta `array` recebe uma matriz JSON com um valor por elemento, aceito pelos `items` do esquema. As portas `object` ainda não podem ser vinculadas por esta API. Não há restrições além do formato de transmissão: o que uma porta aceita (um `enum`, um comprimento) é definido por seu `content_schema`, e o caminho de execução valida com base nesse mesmo esquema.

### WebhookTarget

- `type`: `all` (WebhookTargetAll)
- `type`: `ids` (WebhookTargetIds)
  - `ids` (list of string, required) — Os IDs dos webhooks de fluxos do workspace para os quais o resultado será entregue. Cada um deve ser um dos webhooks de fluxos configurados no workspace.

### TemplateOutput

Uma saída de uma execução de modelo, diferenciada por `type`: o `type` do `content_schema` da porta. Consulte `status` para saber em que estágio do ciclo de vida ela está.

- `type`: `array` (TemplateArrayOutput)
  - `has_more` (boolean, required) — Se a lista tem elementos além de `content`.
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (list of TemplateOutput, optional, nullable) — Os primeiros elementos da lista, em ordem, cada um seguindo a estrutura de `items` do esquema. Presente apenas quando `status` é `completed`. Quando `has_more` é verdadeiro, esta não é a lista completa. Reservado: ainda não há nenhum modelo que produza esse tipo de saída; ele foi publicado para que modelos que o façam possam ser executados com o mesmo cliente.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
  - `next_cursor` (string, optional, nullable) — Passe como `cursor` para um endpoint posterior buscar os elementos após `content`. `null` quando `content` contém a lista inteira ou antes de a saída ser concluída. Reservado: ainda não há template que produza esse tipo de saída; ele é publicado para que templates que o façam possam ser executados com o mesmo cliente.
- `type`: `audio` (TemplateAudioOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content_mime_type` (string, optional, nullable) — O tipo MIME da mídia gerada. Presente apenas quando `status` é `completed`.
  - `content_url` (string, optional, nullable) — Uma URL assinada para baixar a mídia gerada. Presente apenas quando `status` for `completed`. Ela expira cerca de uma hora após o retorno desta resposta; consulte a execução novamente para obter uma URL atualizada.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `boolean` (TemplateBooleanOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (boolean, optional, nullable) — O booleano gerado. Presente apenas quando `status` é `completed`. Reservado: ainda não há nenhum modelo que produza esse tipo de saída; ele foi publicado para que modelos que o façam possam ser executados com o mesmo cliente.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `image` (TemplateImageOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content_mime_type` (string, optional, nullable) — O tipo MIME da mídia gerada. Presente apenas quando `status` é `completed`.
  - `content_url` (string, optional, nullable) — Uma URL assinada para baixar a mídia gerada. Presente apenas quando `status` for `completed`. Ela expira cerca de uma hora após o retorno desta resposta; consulte a execução novamente para obter uma URL atualizada.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `integer` (TemplateIntegerOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (integer, optional, nullable) — O inteiro gerado. Presente apenas quando `status` é `completed`. Reservado: ainda não há nenhum modelo que produza esse tipo de saída; ele foi publicado para que modelos que o façam possam ser executados com o mesmo cliente.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `number` (TemplateNumberOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (double, optional, nullable) — O número gerado. Presente apenas quando `status` é `completed`. Reservado: ainda não há nenhum modelo que produza esse tipo de saída; ele foi publicado para que modelos que o façam possam ser executados com o mesmo cliente.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `object` (TemplateObjectOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (map from string to TemplateOutput, optional, nullable) — Uma saída por campo, indexada pelo nome do campo, cada uma seguindo a estrutura do esquema desse campo. Presente apenas quando `status` é `completed`. Reservado: nenhum modelo produz esse tipo de saída ainda; ele é publicado para que modelos que o façam possam ser executados com o mesmo cliente.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `string` (TemplateStringOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content` (string, optional, nullable) — O texto gerado. Presente apenas quando `status` é `completed`.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`
- `type`: `video` (TemplateVideoOutput)
  - `id` (string, required) — O ID da geração por trás desta saída. Passe-o como referência `generation` para usar a saída como entrada em outro lugar.
  - `status` (enum, required) — O status do ciclo de vida da saída. Ele termina em `completed`, quando os campos de conteúdo da saída são definidos, ou `failed`, quando `failure_reason` e `error_message` são definidos.
    - Allowed values: `pending`, `generating`, `completed`, `failed`
  - `content_mime_type` (string, optional, nullable) — O tipo MIME da mídia gerada. Presente apenas quando `status` é `completed`.
  - `content_url` (string, optional, nullable) — Uma URL assinada para baixar a mídia gerada. Presente apenas quando `status` for `completed`. Ela expira cerca de uma hora após o retorno desta resposta; consulte a execução novamente para obter uma URL atualizada.
  - `error_message` (string, optional, nullable) — Uma descrição da falha legível para humanos. Presente apenas quando `status` for `failed`. Gerações que falham não são cobradas.
  - `failure_reason` (enum, optional, nullable) — A categoria da falha. Presente somente quando `status` é `failed`.
    - Allowed values: `timeout`, `model_error`, `moderated`, `invalid_parameters`, `dependency_failed`, `charging_failed`, `internal_error`

### ValidationError

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

### ValidationErrorLocItems

## Examples

**Request**

```json
{
  "inputs": {
    "prompt": "a corgi on a surfboard",
    "reference": {
      "asset_id": "5xM2KqOnZyce22SPZ9d4",
      "type": "asset"
    }
  },
  "version_id": "latest",
  "webhook": {
    "type": "all"
  }
}
```

**Response**

```json
{
  "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"
    }
  }
}
```

**SDK Code**

```python
import requests

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

payload = {
    "inputs": {
        "prompt": "a corgi on a surfboard",
        "reference": {
            "asset_id": "5xM2KqOnZyce22SPZ9d4",
            "type": "asset"
        }
    },
    "version_id": "latest",
    "webhook": { "type": "all" }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/flows/templates/template_id/runs';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"inputs":{"prompt":"a corgi on a surfboard","reference":{"asset_id":"5xM2KqOnZyce22SPZ9d4","type":"asset"}},"version_id":"latest","webhook":{"type":"all"}}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"inputs\": {\n    \"prompt\": \"a corgi on a surfboard\",\n    \"reference\": {\n      \"asset_id\": \"5xM2KqOnZyce22SPZ9d4\",\n      \"type\": \"asset\"\n    }\n  },\n  \"version_id\": \"latest\",\n  \"webhook\": {\n    \"type\": \"all\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inputs\": {\n    \"prompt\": \"a corgi on a surfboard\",\n    \"reference\": {\n      \"asset_id\": \"5xM2KqOnZyce22SPZ9d4\",\n      \"type\": \"asset\"\n    }\n  },\n  \"version_id\": \"latest\",\n  \"webhook\": {\n    \"type\": \"all\"\n  }\n}"

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.post("https://api.elevenlabs.io/v1/flows/templates/template_id/runs")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": {\n    \"prompt\": \"a corgi on a surfboard\",\n    \"reference\": {\n      \"asset_id\": \"5xM2KqOnZyce22SPZ9d4\",\n      \"type\": \"asset\"\n    }\n  },\n  \"version_id\": \"latest\",\n  \"webhook\": {\n    \"type\": \"all\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/flows/templates/template_id/runs', [
  'body' => '{
  "inputs": {
    "prompt": "a corgi on a surfboard",
    "reference": {
      "asset_id": "5xM2KqOnZyce22SPZ9d4",
      "type": "asset"
    }
  },
  "version_id": "latest",
  "webhook": {
    "type": "all"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"inputs\": {\n    \"prompt\": \"a corgi on a surfboard\",\n    \"reference\": {\n      \"asset_id\": \"5xM2KqOnZyce22SPZ9d4\",\n      \"type\": \"asset\"\n    }\n  },\n  \"version_id\": \"latest\",\n  \"webhook\": {\n    \"type\": \"all\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "inputs": [
    "prompt": "a corgi on a surfboard",
    "reference": [
      "asset_id": "5xM2KqOnZyce22SPZ9d4",
      "type": "asset"
    ]
  ],
  "version_id": "latest",
  "webhook": ["type": "all"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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 = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```