Start Design Task

curl --request POST \
  --url https://api.moda.app/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "conversation_id": "conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "canvas_name": "<string>",
  "brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "skip_brand_kit": false,
  "callback_url": "<string>",
  "idempotency_key": "<string>",
  "attachments": [
    {
      "url": "<string>",
      "name": "<string>",
      "type": "image"
    }
  ],
  "format": {
    "width": 123,
    "height": 123,
    "label": "<string>",
    "page_count": 2
  },
  "reference_canvas_ids": [
    "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
  ],
  "number_of_slides": 2,
  "export_on_complete": {
    "enabled": true,
    "pixel_ratio": 2
  }
}
'

import requests

url = "https://api.moda.app/v1/tasks"

payload = {
    "prompt": "<string>",
    "conversation_id": "conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "canvas_name": "<string>",
    "brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "skip_brand_kit": False,
    "callback_url": "<string>",
    "idempotency_key": "<string>",
    "attachments": [
        {
            "url": "<string>",
            "name": "<string>",
            "type": "image"
        }
    ],
    "format": {
        "width": 123,
        "height": 123,
        "label": "<string>",
        "page_count": 2
    },
    "reference_canvas_ids": ["cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"],
    "number_of_slides": 2,
    "export_on_complete": {
        "enabled": True,
        "pixel_ratio": 2
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: '<string>',
    conversation_id: 'conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    canvas_id: 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    template_canvas_id: 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    canvas_name: '<string>',
    brand_kit_id: 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    skip_brand_kit: false,
    callback_url: '<string>',
    idempotency_key: '<string>',
    attachments: [{url: '<string>', name: '<string>', type: 'image'}],
    format: {width: 123, height: 123, label: '<string>', page_count: 2},
    reference_canvas_ids: ['cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV'],
    number_of_slides: 2,
    export_on_complete: {enabled: true, pixel_ratio: 2}
  })
};

fetch('https://api.moda.app/v1/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moda.app/v1/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'conversation_id' => 'conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'canvas_id' => 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'template_canvas_id' => 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'canvas_name' => '<string>',
    'brand_kit_id' => 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'skip_brand_kit' => false,
    'callback_url' => '<string>',
    'idempotency_key' => '<string>',
    'attachments' => [
        [
                'url' => '<string>',
                'name' => '<string>',
                'type' => 'image'
        ]
    ],
    'format' => [
        'width' => 123,
        'height' => 123,
        'label' => '<string>',
        'page_count' => 2
    ],
    'reference_canvas_ids' => [
        'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV'
    ],
    'number_of_slides' => 2,
    'export_on_complete' => [
        'enabled' => true,
        'pixel_ratio' => 2
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.moda.app/v1/tasks"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"conversation_id\": \"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_name\": \"<string>\",\n  \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"skip_brand_kit\": false,\n  \"callback_url\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"attachments\": [\n    {\n      \"url\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": \"image\"\n    }\n  ],\n  \"format\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"label\": \"<string>\",\n    \"page_count\": 2\n  },\n  \"reference_canvas_ids\": [\n    \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n  ],\n  \"number_of_slides\": 2,\n  \"export_on_complete\": {\n    \"enabled\": true,\n    \"pixel_ratio\": 2\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/tasks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"conversation_id\": \"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_name\": \"<string>\",\n  \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"skip_brand_kit\": false,\n  \"callback_url\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"attachments\": [\n    {\n      \"url\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": \"image\"\n    }\n  ],\n  \"format\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"label\": \"<string>\",\n    \"page_count\": 2\n  },\n  \"reference_canvas_ids\": [\n    \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n  ],\n  \"number_of_slides\": 2,\n  \"export_on_complete\": {\n    \"enabled\": true,\n    \"pixel_ratio\": 2\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.moda.app/v1/tasks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"conversation_id\": \"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_name\": \"<string>\",\n  \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"skip_brand_kit\": false,\n  \"callback_url\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"attachments\": [\n    {\n      \"url\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": \"image\"\n    }\n  ],\n  \"format\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"label\": \"<string>\",\n    \"page_count\": 2\n  },\n  \"reference_canvas_ids\": [\n    \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n  ],\n  \"number_of_slides\": 2,\n  \"export_on_complete\": {\n    \"enabled\": true,\n    \"pixel_ratio\": 2\n  }\n}"

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

{
  "id": "task_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "attempt": 123,
  "max_attempts": 123,
  "links": {
    "self": "<string>",
    "events": "<string>",
    "cancel": "<string>",
    "canvas": "<string>"
  },
  "created_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "progress": {
    "percent": 123,
    "step": "<string>",
    "message": "<string>"
  },
  "input": {},
  "result": {
    "canvas_id": "<string>",
    "canvas_url": "<string>",
    "canvas_name": "<string>",
    "conversation_id": "<string>",
    "source_canvas_id": "<string>",
    "source_canvas_url": "<string>",
    "theme_canvas_id": "<string>",
    "export": {
      "url": "<string>",
      "format": "<string>",
      "status": "<string>",
      "page_count": 123
    }
  },
  "error": {},
  "credits": {
    "credits_used": 123,
    "credits_remaining": 123
  },
  "retry_after_ms": 123
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

POST

tasks

Start Design Task

curl --request POST \
  --url https://api.moda.app/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "conversation_id": "conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "canvas_name": "<string>",
  "brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "skip_brand_kit": false,
  "callback_url": "<string>",
  "idempotency_key": "<string>",
  "attachments": [
    {
      "url": "<string>",
      "name": "<string>",
      "type": "image"
    }
  ],
  "format": {
    "width": 123,
    "height": 123,
    "label": "<string>",
    "page_count": 2
  },
  "reference_canvas_ids": [
    "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
  ],
  "number_of_slides": 2,
  "export_on_complete": {
    "enabled": true,
    "pixel_ratio": 2
  }
}
'

import requests

url = "https://api.moda.app/v1/tasks"

payload = {
    "prompt": "<string>",
    "conversation_id": "conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "canvas_name": "<string>",
    "brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
    "skip_brand_kit": False,
    "callback_url": "<string>",
    "idempotency_key": "<string>",
    "attachments": [
        {
            "url": "<string>",
            "name": "<string>",
            "type": "image"
        }
    ],
    "format": {
        "width": 123,
        "height": 123,
        "label": "<string>",
        "page_count": 2
    },
    "reference_canvas_ids": ["cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"],
    "number_of_slides": 2,
    "export_on_complete": {
        "enabled": True,
        "pixel_ratio": 2
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: '<string>',
    conversation_id: 'conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    canvas_id: 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    template_canvas_id: 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    canvas_name: '<string>',
    brand_kit_id: 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    skip_brand_kit: false,
    callback_url: '<string>',
    idempotency_key: '<string>',
    attachments: [{url: '<string>', name: '<string>', type: 'image'}],
    format: {width: 123, height: 123, label: '<string>', page_count: 2},
    reference_canvas_ids: ['cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV'],
    number_of_slides: 2,
    export_on_complete: {enabled: true, pixel_ratio: 2}
  })
};

fetch('https://api.moda.app/v1/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moda.app/v1/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'conversation_id' => 'conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'canvas_id' => 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'template_canvas_id' => 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'canvas_name' => '<string>',
    'brand_kit_id' => 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
    'skip_brand_kit' => false,
    'callback_url' => '<string>',
    'idempotency_key' => '<string>',
    'attachments' => [
        [
                'url' => '<string>',
                'name' => '<string>',
                'type' => 'image'
        ]
    ],
    'format' => [
        'width' => 123,
        'height' => 123,
        'label' => '<string>',
        'page_count' => 2
    ],
    'reference_canvas_ids' => [
        'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV'
    ],
    'number_of_slides' => 2,
    'export_on_complete' => [
        'enabled' => true,
        'pixel_ratio' => 2
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.moda.app/v1/tasks"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"conversation_id\": \"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_name\": \"<string>\",\n  \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"skip_brand_kit\": false,\n  \"callback_url\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"attachments\": [\n    {\n      \"url\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": \"image\"\n    }\n  ],\n  \"format\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"label\": \"<string>\",\n    \"page_count\": 2\n  },\n  \"reference_canvas_ids\": [\n    \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n  ],\n  \"number_of_slides\": 2,\n  \"export_on_complete\": {\n    \"enabled\": true,\n    \"pixel_ratio\": 2\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/tasks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"conversation_id\": \"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_name\": \"<string>\",\n  \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"skip_brand_kit\": false,\n  \"callback_url\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"attachments\": [\n    {\n      \"url\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": \"image\"\n    }\n  ],\n  \"format\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"label\": \"<string>\",\n    \"page_count\": 2\n  },\n  \"reference_canvas_ids\": [\n    \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n  ],\n  \"number_of_slides\": 2,\n  \"export_on_complete\": {\n    \"enabled\": true,\n    \"pixel_ratio\": 2\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.moda.app/v1/tasks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"conversation_id\": \"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"canvas_name\": \"<string>\",\n  \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n  \"skip_brand_kit\": false,\n  \"callback_url\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"attachments\": [\n    {\n      \"url\": \"<string>\",\n      \"name\": \"<string>\",\n      \"type\": \"image\"\n    }\n  ],\n  \"format\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"label\": \"<string>\",\n    \"page_count\": 2\n  },\n  \"reference_canvas_ids\": [\n    \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n  ],\n  \"number_of_slides\": 2,\n  \"export_on_complete\": {\n    \"enabled\": true,\n    \"pixel_ratio\": 2\n  }\n}"

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

{
  "id": "task_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "attempt": 123,
  "max_attempts": 123,
  "links": {
    "self": "<string>",
    "events": "<string>",
    "cancel": "<string>",
    "canvas": "<string>"
  },
  "created_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "progress": {
    "percent": 123,
    "step": "<string>",
    "message": "<string>"
  },
  "input": {},
  "result": {
    "canvas_id": "<string>",
    "canvas_url": "<string>",
    "canvas_name": "<string>",
    "conversation_id": "<string>",
    "source_canvas_id": "<string>",
    "source_canvas_url": "<string>",
    "theme_canvas_id": "<string>",
    "export": {
      "url": "<string>",
      "format": "<string>",
      "status": "<string>",
      "page_count": 123
    }
  },
  "error": {},
  "credits": {
    "credits_used": 123,
    "credits_remaining": 123
  },
  "retry_after_ms": 123
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

{
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

Authorizations

Authorization

string

header

required

API key from Settings > Developer > REST API

Headers

Moda-Version

enum<string>

default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:

2026-04-12,

2026-05-01

Example:

"2026-05-01"

Body

application/json

prompt

string

required

Natural-language description of the design task for the AI agent.

conversation_id

string | null

Prefixed conv_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Pattern: ^conv_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Example:

"conv_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

canvas_id

string | null

Prefixed cvs_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

template_canvas_id

string | null

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

canvas_name

string | null

Name for the new canvas. Used when creating (canvas_id omitted) or when remixing via template_canvas_id (overrides the default Remix of <source>).

brand_kit_id

string | null

Prefixed bk_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Pattern: ^bk_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Example:

"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

skip_brand_kit

boolean

default:false

If true, no brand kit is applied — every brand-kit source is suppressed, including the canvas's own kit, the team default, and any explicit brand_kit_id override. Use only when the design must be unbranded; to merely leave the canvas's existing kit alone, omit brand_kit_id instead.

callback_url

string | null

HTTPS URL to receive a webhook POST when the job completes, fails, or is cancelled. See the Webhooks documentation for payload format and signature verification.

idempotency_key

string | null

Client-generated unique key to prevent duplicate job creation. If a job with this key already exists, its status is returned instead of creating a new one.

attachments

(AttachmentInput · object | FileAttachment · object)[] | null

List of reference images or files for the AI agent to use as inspiration. Each item is either a URL-shape attachment ({url, name?, type?}) or a file-id-shape attachment ({file_id, role, label?}) referencing a file previously uploaded via POST /v1/uploads. The two shapes are distinguished by their required fields (url vs file_id).

AttachmentInput
FileAttachment

Show child attributes

format

FormatInput · object | null

Canvas format and dimensions. Controls the output size and layout type (e.g. slides, social media, custom).

Show child attributes

model_tier

enum<string> | null

AI model tier: 'pro' (best for complex tasks), 'pro-fast' (the same quality as Pro with faster output and higher credit usage), 'standard', 'lite', 'kimi-k2.5' (Fireworks-hosted Kimi K2.5), 'kimi-k2.6' (Fireworks-hosted Kimi K2.6), 'kimi-k3' (Moonshot-hosted Kimi K3), or 'gpt-5.6' (OpenAI GPT-5.6 at high reasoning). Defaults to automatic selection based on task complexity.

Available options:

pro,

pro-fast,

standard,

lite,

kimi-k2.5,

kimi-k2.6,

kimi-k3,

gpt-5.6

reference_canvas_ids

string[] | null

List of prefixed cvs_ IDs to use as design inspiration. The agent can see these designs and reference their style, layout, or content.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

number_of_slides

integer | null

Optional maximum number of slides for slide-generation jobs. When omitted for slides, Moda defaults to an 8-slide target and clamps to your plan limit.

Required range: x >= 1

export_on_complete

ExportOnCompleteOption · object | null

Auto-export preferences applied when the task finishes. The finished design is rendered to result.export (and the completion webhook), so a follow-up POST /v1/canvases/{id}/export for the same canvas hits the cache instead of re-rendering. Omit to use the canvas category default (slides→PPTX, pdf→PDF, others→PNG); pass {enabled: false} to opt out of the auto-export entirely. Multi-page PNG/JPEG bundles into a .zip of per-page files; result.export.format reflects what was actually delivered (png, jpeg, pdf, pptx, or zip).

Show child attributes

Response

Successful Response

Canonical wire-format for every async design operation.

All consumers -- REST, webhooks, SSE, MCP -- serialize through Task.from_db() so the shape is always consistent.

string

required

Prefixed task_... identifier.

Pattern: ^task_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Example:

"task_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

kind

enum<string>

required

Discriminator for the kind-specific result payload.

Available options:

design,

export,

remix,

brand_kit_extract

status

enum<string>

required

Current lifecycle status.

Available options:

queued,

running,

succeeded,

failed,

canceled,

expired

attempt

integer

required

Current attempt number (1-based).

max_attempts

integer

required

Maximum attempts before dead-lettering.

links

TaskLinks · object

required

HATEOAS links for this task.

Show child attributes

created_at

string | null

ISO 8601 timestamp.

started_at

string | null

ISO 8601 timestamp.

completed_at

string | null

ISO 8601 timestamp.

progress

TaskProgress · object | null

Live progress for running tasks. Null when not applicable.

Show child attributes

input

Input · object | null

Sanitized echo of the original request.

result

TaskResult · object | null

Result payload. Present only for succeeded tasks.

Show child attributes

error

Error · object | null

Error info for failed tasks: {message, retryable}.

credits

CreditUsage · object | null

Credit usage. Present only for completed tasks when billing is enabled.

Show child attributes

retry_after_ms

integer | null

Suggested milliseconds to wait before the next poll. Null for terminal tasks.

⌘I

Overview

canvases

canvas-actions

tasks

organizations

credits

brand-kits

remix

share-links

uploads

usage

webhooks

drive

media

web

websites

Start Design Task

Authorizations

Headers

Body

Response