LogoCloudflare API

AI

ai

Methods

Execute AI Model -> Envelope<Array<{ label, score }> | string | { audio } | 12 more...>
post/accounts/{account_id}/ai/run/{model_name}

This endpoint provides users with the capability to run specific AI models on-demand.

By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases.

Model specific inputs available in Cloudflare Docs.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Workers AI Write Workers AI Read

path Parameters
account_id: string
model_name: string
Response fields
result: Array<{ label, score }> | string | { audio } | 12 more...
Optional

An array of classification results for the input text

Request example
200Example
AI

Authors

ai.authors

Methods

Author Search -> SinglePage<unknown>
get/accounts/{account_id}/ai/authors/search

Searches Workers AI models by author or organization name.

AI

Finetunes

ai.finetunes

Methods

List Finetunes -> Envelope<{ id, created_at, model, 3 more... }>
get/accounts/{account_id}/ai/finetunes

Lists all fine-tuning jobs created by the account, including status and metrics.

Create A New Finetune -> Envelope<{ id, created_at, model, 4 more... }>
post/accounts/{account_id}/ai/finetunes

Creates a new fine-tuning job for a Workers AI model using custom training data.

AIFinetunes

Assets

ai.finetunes.assets

Methods

Upload A Finetune Asset -> { success }
post/accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets

Uploads training data assets for a Workers AI fine-tuning job.

AIFinetunes

Public

ai.finetunes.public

Methods

List Public Finetunes -> SinglePage<{ id, created_at, model, 4 more... }>
get/accounts/{account_id}/ai/finetunes/public

Lists publicly available fine-tuned models that can be used with Workers AI.

AI

Models

ai.models

Methods

Model Search -> V4PagePaginationArray<unknown>
get/accounts/{account_id}/ai/models/search

Searches Workers AI models by name or description.

AIModels

Schema

ai.models.schema

Methods

Get Model Schema -> Envelope<{ input, output }>
get/accounts/{account_id}/ai/models/schema

Retrieves the input and output JSON schema definition for a Workers AI model.

AI

Tasks

ai.tasks

Methods

Task Search -> SinglePage<unknown>
get/accounts/{account_id}/ai/tasks/search

Searches Workers AI models by task type (e.g., text-generation, embeddings).

AI

To Markdown

ai.to_markdown

Methods

Convert Files Into Markdown -> SinglePage<{ data, format, mimeType, 2 more... }>
post/accounts/{account_id}/ai/tomarkdown

Converts uploaded files into Markdown format using Workers AI.

Get All Converted Formats Supported -> SinglePage<{ extension, mimeType }>
get/accounts/{account_id}/ai/tomarkdown/supported

Lists all file formats supported for conversion to Markdown.