Create Task

Create a new task.


POST
/tasks

Authorization

AuthorizationRequiredBearer <token>

See API Security for more details.

In: header

Request Body

application/jsonRequired

The request body should contain a properly formatted JSON object with one of url or file_id, plus a kind. See Tasks for more details.

urlstring
Format: "uri"
file_idstring
kindRequiredstring
Value in: "ingest" | "video" | "image" | "audio" | "chapters" | "subtitles" | "thumbnails" | "nsfw" | "speech" | "description" | "outline" | "prompt" | "workflow" | "conditions" | "http"
filenamestring
folderstring
refstring
webhook_urlstring
Format: "uri"

Response Body

Success

TypeScript Definitions

Use the response body type in TypeScript.

metaobject
dataobject
errorobject | null | null
linksobject
const body = JSON.stringify({
  "file_id": "file_abcdefgh1234",
  "kind": "image",
  "width": 320,
  "format": "png",
  "ref": "thumbnail"
})

fetch("https://api.ittybit.com/tasks", {
  headers: {
    "Authorization": "Bearer <token>"
  },
  body
})
{
  "meta": {
    "request_id": "req_abcdefghij1234567890",
    "org_id": "org_abcdefgh1234",
    "project_id": "prj_abcdefgh1234",
    "version": "2025-01-01",
    "type": "object"
  },
  "data": {
    "id": "task_abcdefgh1234",
    "object": "task",
    "kind": "image",
    "input": {
      "id": "file_abcdefgh1234",
      "object": "source",
      "kind": "video",
      "type": "video/mp4",
      "width": 1920,
      "height": 1080,
      "duration": 123.45,
      "filesize": 12345678,
      "url": "https://you.ittybit.net/file_abcdefgh1234",
      "ref": "original"
    },
    "options": {
      "width": 320,
      "format": "png",
      "ref": "thumbnail"
    },
    "output": null,
    "status": "pending",
    "created": "2025-01-01T01:23:45Z",
    "updated": "2025-01-01T01:23:45Z"
  },
  "links": {
    "self": "https://api.ittybit.com/tasks/task_abcdefgh1234",
    "parent": "https://api.ittybit.com/tasks"
  }
}