# createGeneration

`createGeneration`

`POST /v1/generations`

Each accepted POST durably records a separate generation. While pending_funding the reserved amount is zero. Funding success queues the job; check its status for a funding rejection. Submitting the same request twice can incur two charges. After a lost response, check the generation list before deciding to create another task.

## Authentication

Send your project key in the request header, for example `Authorization: Bearer $VIZO_API_KEY`. Keep the key on your server.

## Request body

- `input` (object, Required) Generation parameters. The fields depend on the model and operation; see the model page.
  - `aspect_ratio` (string, Optional)
  - `asset_id` (string, Optional) At most 128 characters
  - `duration_seconds` (integer, Optional) Minimum -1
  - `generate_audio` (boolean, Optional)
  - `native` (any, Optional)
  - `prompt` (string, Optional) At least 1 characters At most 4000 characters
  - `resolution` (string, Optional)
  - `source_generation_id` (string, Optional) At most 128 characters
  - `video` (object, Optional)
    - `bitrate_mode` (string, Optional)
    - `content` (object[], Optional, can be null)
      - `asset_id` (string, Optional)
      - `draft_generation_id` (string, Optional)
      - `role` (string, Optional)
      - `text` (string, Optional)
      - `type` (string, Required)
      - `url` (string, Optional)
    - `draft` (boolean, Optional)
    - `execution_expires_after` (integer, Optional)
    - `moderation_options` (object, Optional)
      - `ips` (string[], Required, can be null)
    - `omni_reference_task_type` (string, Optional)
    - `output_format` (string, Optional)
    - `return_last_frame` (boolean, Optional)
    - `safety_identifier` (string, Optional)
    - `seed` (integer, Optional)
    - `tools` (object[], Optional, can be null)
      - `type` (string, Required)
    - `watermark` (boolean, Optional)
- `metadata` (map<string, string>, Optional) Your own string values, returned unchanged. Put client_reference here so a lost response can be matched later.
- `model` (string, Required) Model ID from listModels or the model page. At least 1 characters
- `operation` (string, Required) What to generate. Only operations published for the model are accepted. Allowed values: `text-to-video`, `image-to-video`, `reference-to-video`, `video-edit`, `video-extend`, `video-draft`, `draft-to-video`, `generate-image`, `generate-audio`, `clone-voice`, `generate-video`, `process-video`
- `quote_id` (string, Optional) At least 1 characters
- `routing` (object, Optional) Pin a specific route. Without it the platform picks the published route for the model.
  - `mode` (string, Required) Allowed values: `pinned`
  - `route` (string, Required) At least 1 characters
- `webhook_endpoint_id` (string, Optional) Webhook endpoint to notify when the task changes state. Create endpoints in the console.

```json
{
  "model": "MODEL_FROM_PROJECT",
  "operation": "text-to-video",
  "input": {
    "prompt": "A paper boat drifting on a pond",
    "duration_seconds": 5
  }
}
```

## Responses

### 202 Accepted

- `allowed_actions` (string[], Required, can be null) Actions you can take now, such as cancel. Rely on this list instead of inferring from the status.
- `billing_status` (string, Required) Whether Credits are held, charged or released.
- `closed_at` (date-time, Required, can be null) When the task closed. Stop polling once it is not null.
- `customer_resolution_deadline` (date-time, Required) Twenty-four hours after acceptance. Holds still unsettled at this time are released.
- `delivery_status` (string, Required) Whether the result is stored and downloadable. ready means it can be downloaded.
- `error` (object, Required, can be null) Set when the task closed without a result. Read error.code.
  - `code` (string, Required) Why the task closed without a result, for example insufficient_balance, budget_exceeded or spending_blocked.
- `execution_status` (string, Required) Progress of the model run.
- `id` (string, Required) Resource ID. Save it as soon as you receive it.
- `late_result_available` (boolean, Required) A result that arrived after closing is provided at no charge.
- `metadata` (map<string, string>, Optional) Your own string values, returned unchanged. Put client_reference here so a lost response can be matched later.
- `price` (object, Required) Credits for this task: quoted (the price when it was accepted), reserved and charged. charged stays 0.000 until settlement.
  - `charged` (string, Required)
  - `price_version` (string, Required)
  - `quoted` (string, Required)
  - `reserved` (string, Required)
  - `unit` (string, Required) Allowed values: `credit`
- `result` (object, Required, can be null) Delivered assets, once available.
  - `asset_id` (string, Optional)
  - `last_frame_asset_id` (string, Optional)
  - `metadata` (object, Optional)
    - `duration` (integer, Optional)
    - `frames` (integer, Optional)
    - `framespersecond` (integer, Optional)
    - `generate_audio` (boolean, Optional)
    - `ratio` (string, Optional)
    - `resolution` (string, Optional)
    - `seed` (integer, Optional)
  - `outputs` (object[], Optional, can be null)
    - `asset_id` (string, Required)
    - `content_type` (string, Required)
    - `index` (integer, Required)
  - `voice_id` (string, Optional)
- `status` (string, Required) Overall state of the task.
- `version` (integer, Required)

```json
{
  "allowed_actions": [
    "cancel"
  ],
  "billing_status": "held",
  "closed_at": null,
  "customer_resolution_deadline": "2026-11-03T08:00:12Z",
  "delivery_status": "pending",
  "error": null,
  "execution_status": "queued",
  "id": "gen_01JD8Z5QW3XR",
  "late_result_available": false,
  "metadata": {
    "client_reference": "order-1042"
  },
  "price": {
    "charged": "0.000",
    "price_version": "p3",
    "quoted": "1400.000",
    "reserved": "1400.000",
    "unit": "credit"
  },
  "result": null,
  "status": "queued",
  "version": 1
}
```

### 401 Unauthorized

```json
{
  "error": {
    "code": "invalid_credentials",
    "message": "API key is missing, malformed, expired or revoked.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 402 Payment Required

```json
{
  "error": {
    "code": "insufficient_balance",
    "message": "Available credits cannot cover the hold.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 403 Forbidden

```json
{
  "error": {
    "code": "scope_denied",
    "message": "The key does not allow this operation for this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 404 Not Found

```json
{
  "error": {
    "code": "resource_not_found",
    "message": "The resource is not available to this project.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 409 Conflict

```json
{
  "error": {
    "code": "conflict",
    "message": "The request conflicts with the current state of the resource.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 422 Unprocessable Entity

```json
{
  "error": {
    "code": "invalid_input",
    "message": "Input does not match the published schema.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 429 Too Many Requests

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Check Retry-After.",
    "retryable": true,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 500 Internal Server Error

```json
{
  "error": {
    "code": "request_failed",
    "message": "The request failed. Check recent generations before submitting again.",
    "retryable": false,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

### 503 Service Unavailable

```json
{
  "error": {
    "code": "temporarily_unavailable",
    "message": "Service is temporarily unavailable.",
    "retryable": true,
    "request_id": "9f2c41d07ab3e5c8"
  }
}
```

## Errors

Errors share one body. Include the request_id when you contact support.

### Error body

- `error` (object, Required) Details of the error.
  - `code` (string, Required) Stable error code to branch on.
  - `message` (string, Required) Readable explanation. Do not parse it.
  - `request_id` (string, Required) Include this when you contact support.
  - `retryable` (boolean, Required) True for 429 and 503 only. Even then, check recent tasks before you send a create request again.
  - `task_id` (string, Optional) The task this error belongs to, when one exists.

| Status | What it means and what to do |
| --- | --- |
| 401 | The key is missing, malformed, expired or revoked. Correct the key on your server, then continue. |
| 402 | Available Credits cannot cover this request. Add Credits, wait for them to be credited, then check the balance. |
| 403 | The key scope, email verification, a budget or an account restriction blocks this. Check the key type, scopes and project budget. |
| 404 | The model or resource does not exist or is outside this project. Check the project, the ID and that the model is enabled. |
| 409 | The request conflicts with the current state. Read the resource again and decide whether to send the request again. |
| 422 | A field or value is invalid. Compare the request with the field table and the model page. |
| 429 | Too many requests. No task was created. Wait for the Retry-After time before sending again. |
| 500 | The server failed and the task may already be accepted. Do not resend; list recent tasks first. |
| 503 | The service is temporarily unavailable. For a create request, list recent tasks and confirm none was accepted before you submit again. |
| Timeout or disconnect | No response, or the connection dropped. The task may be accepted. With a task ID, read that task; without one, find it by client_reference in the task list. |

### cURL

```bash
curl -X POST "https://api.vizoapi.com/v1/generations" \
  -H "Authorization: Bearer $VIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_FROM_PROJECT",
    "operation": "text-to-video",
    "input": {
      "prompt": "A paper boat drifting on a pond",
      "duration_seconds": 5
    }
  }'
```

### Python

```python
import os, requests

res = requests.post(
    "https://api.vizoapi.com/v1/generations",
    headers={"Authorization": f"Bearer {os.environ['VIZO_API_KEY']}"},
    json={
      "model": "MODEL_FROM_PROJECT",
      "operation": "text-to-video",
      "input": {
        "prompt": "A paper boat drifting on a pond",
        "duration_seconds": 5
      }
    },
    timeout=60,
)
print(res.status_code, res.json())
```

### Node.js

```javascript
const res = await fetch("https://api.vizoapi.com/v1/generations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VIZO_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "MODEL_FROM_PROJECT",
    "operation": "text-to-video",
    "input": {
      "prompt": "A paper boat drifting on a pond",
      "duration_seconds": 5
    }
  }),
});
console.log(res.status, await res.json());
```