Create a generation

curl --request POST \
  --url https://codzen.ai/api/v1/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": {},
  "webhook_url": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({model: '<string>', input: {}, webhook_url: '<string>'})
};

fetch('https://codzen.ai/api/v1/generations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://codzen.ai/api/v1/generations"

payload = {
    "model": "<string>",
    "input": {},
    "webhook_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "model": "<string>",
  "status": "queued",
  "input": {},
  "outputs": [
    {
      "type": "video",
      "url": "<string>"
    }
  ],
  "cost": {
    "currency": "USD",
    "estimated": "<string>",
    "amount": "<string>",
    "usage": [
      {
        "unit": "<string>",
        "quantity": 1,
        "unit_price": "<string>"
      }
    ]
  },
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

POST

generations

Create a generation

curl --request POST \
  --url https://codzen.ai/api/v1/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": {},
  "webhook_url": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({model: '<string>', input: {}, webhook_url: '<string>'})
};

fetch('https://codzen.ai/api/v1/generations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://codzen.ai/api/v1/generations"

payload = {
    "model": "<string>",
    "input": {},
    "webhook_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "model": "<string>",
  "status": "queued",
  "input": {},
  "outputs": [
    {
      "type": "video",
      "url": "<string>"
    }
  ],
  "cost": {
    "currency": "USD",
    "estimated": "<string>",
    "amount": "<string>",
    "usage": [
      {
        "unit": "<string>",
        "quantity": 1,
        "unit_price": "<string>"
      }
    ]
  },
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "stage": "input"
  },
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Your API key (cz_…), created in the console. Use it only on your server.

Body

application/json

A generation to submit.

model

string

required

Slug of the model, such as seedance-2-5.

input

object

required

The model's input. Its fields depend on the model: see the model's reference, linked from the Models index. Unknown fields are rejected.

Show child attributes

webhook_url

string<uri>

HTTPS URL to call once the generation finishes.

Response

The generation, queued.

One generation: a request to a model and its outputs.

string

required

ID of the generation.

Pattern: ^gen_

model

string

required

Slug of the model, as submitted.

status

enum<string>

required

queued → processing → succeeded or failed. New values may be added; treat an unknown value as not finished.

Available options:

queued,

processing,

succeeded,

failed

input

object

required

The input, normalized: input assets point at Codzen copies; other fields are as submitted.

Show child attributes

outputs

object[]

required

Delivered outputs; empty until the generation succeeds.

Show child attributes

cost

object

required

What the generation costs.

Show child attributes

error

object | null

required

Why the generation failed; null unless it failed.

Show child attributes

created_at

string<date-time>

required

ISO 8601 time in UTC.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

started_at

string<date-time> | null

required

When processing started; null while queued.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

completed_at

string<date-time> | null

required

When the generation finished; null until then.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

Get started

Guides

API reference

Models

Create a generation

Authorizations

Body

Response