--- title: AI --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # AI ##### [Run a Workers AI model](https://developers.cloudflare.com/api/typescript/resources/ai/methods/run) client.ai.run(stringmodelName, AIRunParamsparams, RequestOptionsoptions?): [AIRunResponse]() POST/accounts/{account\_id}/ai/run/{model\_name} ##### ModelsExpand Collapse
AIRunResponse = Array<TextClassification>| Uploadable| Audio {audio } | 12 more An array of classification results for the input text One of the following:
Array<TextClassification> label?: string The classification label assigned to the text (e.g., ‘POSITIVE’ or ‘NEGATIVE’) Link to this property score?: number Confidence score indicating the likelihood that the text belongs to the specified label Link to this property
Link to this property Uploadable Link to this property
Audio {audio } audio?: string The generated audio in MP3 format, base64-encoded Link to this property
Link to this property Uploadable Link to this property
TextEmbeddings {data, shape } data?: Array<Array<number>> Embeddings of the requested text values Link to this property shape?: Array<number> Link to this property
Link to this property
AutomaticSpeechRecognition {text, vtt, word\_count, words } text: string The transcription Link to this property vtt?: string Link to this property word\_count?: number Link to this property
words?: Array<Word> end?: number The ending second when the word completes Link to this property start?: number The second this word begins in the recording Link to this property word?: string Link to this property
Link to this property
Link to this property
Array<ImageClassification> label?: string The predicted category or class for the input image based on analysis Link to this property score?: number A confidence value, between 0 and 1, indicating how certain the model is about the predicted label Link to this property
Link to this property
Array<ObjectDetection>
box?: Box {xmax, xmin, ymax, ymin } Coordinates defining the bounding box around the detected object xmax?: number The x-coordinate of the bottom-right corner of the bounding box Link to this property xmin?: number The x-coordinate of the top-left corner of the bounding box Link to this property ymax?: number The y-coordinate of the bottom-right corner of the bounding box Link to this property ymin?: number The y-coordinate of the top-left corner of the bounding box Link to this property
Link to this property label?: string The class label or name of the detected object Link to this property score?: number Confidence score indicating the likelihood that the detection is correct Link to this property
Link to this property
UnionMember8 {response, tool\_calls, usage } response: string The generated text response from the model Link to this property
tool\_calls?: Array<ToolCall> An array of tool calls requests made during the response generation arguments?: unknown The arguments passed to be passed to the tool call request Link to this property name?: string The name of the tool to be called Link to this property
Link to this property
usage?: Usage {completion\_tokens, prompt\_tokens, total\_tokens } Usage statistics for the inference request completion\_tokens?: number Total number of tokens in output Link to this property prompt\_tokens?: number Total number of tokens in input Link to this property total\_tokens?: number Total number of input and output tokens Link to this property
Link to this property
Link to this property Uploadable Link to this property
Translation {translated\_text } translated\_text?: string The translated text in the target language Link to this property
Link to this property
Summarization {summary } summary?: string The summarized version of the input text Link to this property
Link to this property
ImageToText {description } description?: string Link to this property
Link to this property
ImageTextToText {description } description?: string Link to this property
Link to this property
MultimodalEmbeddings {data, shape } data?: Array<Array<number>> Link to this property shape?: Array<number> Link to this property
Link to this property
[Link to this property](<#(resource)%20ai%20%3E%20(model)%20ai_run_response%20%3E%20(schema)>) #### AIFinetunes ##### [List Finetunes](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/finetunes/methods/list) client.ai.finetunes.list(FinetuneListParams {account\_id } params, RequestOptionsoptions?): [FinetuneListResponse]() {id, created\_at, model, 3 more } GET/accounts/{account\_id}/ai/finetunes ##### [Create a new Finetune](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/finetunes/methods/create) client.ai.finetunes.create(FinetuneCreateParams {account\_id, model, name, 2 more } params, RequestOptionsoptions?): [FinetuneCreateResponse]() {id, created\_at, model, 4 more } POST/accounts/{account\_id}/ai/finetunes ##### ModelsExpand Collapse
FinetuneListResponse {id, created\_at, model, 3 more } id: string formatuuid Link to this property created\_at: string formatdate-time Link to this property model: string Link to this property modified\_at: string formatdate-time Link to this property name: string Link to this property description?: string Link to this property
[Link to this property](<#(resource)%20ai.finetunes%20%3E%20(model)%20finetune_list_response%20%3E%20(schema)>)
FinetuneCreateResponse {id, created\_at, model, 4 more } id: string formatuuid Link to this property created\_at: string formatdate-time Link to this property model: string Link to this property modified\_at: string formatdate-time Link to this property name: string Link to this property public: boolean Link to this property description?: string Link to this property
[Link to this property](<#(resource)%20ai.finetunes%20%3E%20(model)%20finetune_create_response%20%3E%20(schema)>) #### AIFinetunesAssets ##### [Upload a Finetune Asset](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/finetunes/subresources/assets/methods/create) client.ai.finetunes.assets.create(stringfinetuneID, AssetCreateParams {account\_id, file, file\_name } params, RequestOptionsoptions?): [AssetCreateResponse]() {success } POST/accounts/{account\_id}/ai/finetunes/{finetune\_id}/finetune-assets ##### ModelsExpand Collapse
AssetCreateResponse {success } success: boolean Link to this property
[Link to this property](<#(resource)%20ai.finetunes.assets%20%3E%20(model)%20asset_create_response%20%3E%20(schema)>) #### AIFinetunesPublic ##### [List Public Finetunes](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/finetunes/subresources/public/methods/list) client.ai.finetunes.public.list(PublicListParams {account\_id, limit, offset, orderBy } params, RequestOptionsoptions?): SinglePage< [PublicListResponse]() {id, created\_at, model, 4 more } > GET/accounts/{account\_id}/ai/finetunes/public ##### ModelsExpand Collapse
PublicListResponse {id, created\_at, model, 4 more } id: string formatuuid Link to this property created\_at: string formatdate-time Link to this property model: string Link to this property modified\_at: string formatdate-time Link to this property name: string Link to this property public: boolean Link to this property description?: string Link to this property
[Link to this property](<#(resource)%20ai.finetunes.public%20%3E%20(model)%20public_list_response%20%3E%20(schema)>) #### AIAuthors ##### [Author Search](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/authors/methods/list) client.ai.authors.list(AuthorListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [AuthorListResponse]()> GET/accounts/{account\_id}/ai/authors/search ##### ModelsExpand Collapse AuthorListResponse = unknown [Link to this property](<#(resource)%20ai.authors%20%3E%20(model)%20author_list_response%20%3E%20(schema)>) #### AITasks ##### [Task Search](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/tasks/methods/list) client.ai.tasks.list(TaskListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [TaskListResponse]()> GET/accounts/{account\_id}/ai/tasks/search ##### ModelsExpand Collapse TaskListResponse = unknown [Link to this property](<#(resource)%20ai.tasks%20%3E%20(model)%20task_list_response%20%3E%20(schema)>) #### AIModels ##### [Model Search](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/models/methods/list) client.ai.models.list(ModelListParams {account\_id, author, format, 7 more } params, RequestOptionsoptions?): V4PagePaginationArray< [ModelListResponse]()> GET/accounts/{account\_id}/ai/models/search ##### ModelsExpand Collapse ModelListResponse = unknown [Link to this property](<#(resource)%20ai.models%20%3E%20(model)%20model_list_response%20%3E%20(schema)>) #### AIModelsSchema ##### [Get an AI model's input and output schemas](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/models/subresources/schema/methods/get) client.ai.models.schema.get(SchemaGetParams {account\_id, model } params, RequestOptionsoptions?): [SchemaGetResponse]() {input, output } GET/accounts/{account\_id}/ai/models/schema ##### ModelsExpand Collapse
SchemaGetResponse {input, output }
input: Input {additionalProperties, description, type } additionalProperties: boolean Link to this property description: string Link to this property type: string Link to this property
Link to this property
output: Output {additionalProperties, description, type } additionalProperties: boolean Link to this property description: string Link to this property type: string Link to this property
Link to this property
[Link to this property](<#(resource)%20ai.models.schema%20%3E%20(model)%20schema_get_response%20%3E%20(schema)>) #### AITo Markdown ##### [Convert uploaded files to Markdown](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/to_markdown/methods/transform) client.ai.toMarkdown.transform(ToMarkdownTransformParams {account\_id, file } params, RequestOptionsoptions?): SinglePage< [ToMarkdownTransformResponse]() {data, format, mimeType, 2 more } > POST/accounts/{account\_id}/ai/tomarkdown ##### [List supported Markdown conversion formats](https://developers.cloudflare.com/api/typescript/resources/ai/subresources/to_markdown/methods/supported) client.ai.toMarkdown.supported(ToMarkdownSupportedParams {account\_id } params, RequestOptionsoptions?): SinglePage< [ToMarkdownSupportedResponse]() {extension, mimeType } > GET/accounts/{account\_id}/ai/tomarkdown/supported ##### ModelsExpand Collapse
ToMarkdownTransformResponse {data, format, mimeType, 2 more } data: string Link to this property format: string Link to this property mimeType: string Link to this property name: string Link to this property tokens: string Link to this property
[Link to this property](<#(resource)%20ai.to_markdown%20%3E%20(model)%20to_markdown_transform_response%20%3E%20(schema)>)
ToMarkdownSupportedResponse {extension, mimeType } extension: string Link to this property mimeType: string Link to this property
[Link to this property](<#(resource)%20ai.to_markdown%20%3E%20(model)%20to_markdown_supported_response%20%3E%20(schema)>)