AI

Run a Workers AI model

POST/accounts/{account_id}/ai/run/{model_name}

ModelsExpand Collapse

AIRunResponse = array of object { label, score } or string or object { audio } or 12 more

An array of classification results for the input text

One of the following:

TextClassification = array of object { label, score }

An array of classification results for the input text

label: optional string

The classification label assigned to the text (e.g., ‘POSITIVE’ or ‘NEGATIVE’)

score: optional number

Confidence score indicating the likelihood that the text belongs to the specified label

TextToImage = string

The generated image in PNG format

Audio object { audio }

audio: optional string

The generated audio in MP3 format, base64-encoded

string

The generated audio in MP3 format

TextEmbeddings object { data, shape }

data: optional array of array of number

Embeddings of the requested text values

shape: optional array of number

AutomaticSpeechRecognition object { text, vtt, word_count, words }

text: string

The transcription

vtt: optional string

word_count: optional number

words: optional array of object { end, start, word }

end: optional number

The ending second when the word completes

start: optional number

The second this word begins in the recording

word: optional string

ImageClassification = array of object { label, score }

label: optional string

The predicted category or class for the input image based on analysis

score: optional number

A confidence value, between 0 and 1, indicating how certain the model is about the predicted label

ObjectDetection = array of object { box, label, score }

An array of detected objects within the input image

box: optional object { xmax, xmin, ymax, ymin }

Coordinates defining the bounding box around the detected object

xmax: optional number

The x-coordinate of the bottom-right corner of the bounding box

xmin: optional number

The x-coordinate of the top-left corner of the bounding box

ymax: optional number

The y-coordinate of the bottom-right corner of the bounding box

ymin: optional number

The y-coordinate of the top-left corner of the bounding box

label: optional string

The class label or name of the detected object

score: optional number

Confidence score indicating the likelihood that the detection is correct

object { response, tool_calls, usage }

response: string

The generated text response from the model

tool_calls: optional array of object { arguments, name }

An array of tool calls requests made during the response generation

arguments: optional unknown

The arguments passed to be passed to the tool call request

The name of the tool to be called

usage: optional object { completion_tokens, prompt_tokens, total_tokens }

Usage statistics for the inference request

completion_tokens: optional number

Total number of tokens in output

prompt_tokens: optional number

Total number of tokens in input

total_tokens: optional number

Total number of input and output tokens

string

Translation object { translated_text }

translated_text: optional string

The translated text in the target language

Summarization object { summary }

summary: optional string

The summarized version of the input text

ImageToText object { description }

description: optional string

ImageTextToText object { description }

description: optional string

MultimodalEmbeddings object { data, shape }

data: optional array of array of number

shape: optional array of number

AIFinetunes

List Finetunes

GET/accounts/{account_id}/ai/finetunes

Create a new Finetune

POST/accounts/{account_id}/ai/finetunes

ModelsExpand Collapse

FinetuneListResponse object { id, created_at, model, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

model: string

modified_at: string

formatdate-time

description: optional string

FinetuneCreateResponse object { id, created_at, model, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

model: string

modified_at: string

formatdate-time

public: boolean

description: optional string

AIFinetunesAssets

Upload a Finetune Asset

POST/accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets

ModelsExpand Collapse

AssetCreateResponse object { success }

success: boolean

AIFinetunesPublic

List Public Finetunes

GET/accounts/{account_id}/ai/finetunes/public

ModelsExpand Collapse

PublicListResponse object { id, created_at, model, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

model: string

modified_at: string

formatdate-time

public: boolean

description: optional string

AIAuthors

Author Search

GET/accounts/{account_id}/ai/authors/search

ModelsExpand Collapse

AuthorListResponse = unknown

AITasks

Task Search

GET/accounts/{account_id}/ai/tasks/search

ModelsExpand Collapse

TaskListResponse = unknown

AIModels

Model Search

GET/accounts/{account_id}/ai/models/search

ModelsExpand Collapse

ModelListResponse = unknown

AIModelsSchema

Get an AI model's input and output schemas

GET/accounts/{account_id}/ai/models/schema

ModelsExpand Collapse

SchemaGetResponse object { input, output }

input: object { additionalProperties, description, type }

additionalProperties: boolean

description: string

type: string

output: object { additionalProperties, description, type }

additionalProperties: boolean

description: string

type: string

AITo Markdown

Convert uploaded files to Markdown

POST/accounts/{account_id}/ai/tomarkdown

List supported Markdown conversion formats

GET/accounts/{account_id}/ai/tomarkdown/supported

ModelsExpand Collapse

ToMarkdownTransformResponse object { data, format, mimeType, 2 more }

data: string

format: string

mimeType: string

tokens: string

ToMarkdownSupportedResponse object { extension, mimeType }

extension: string

mimeType: string