Cloudflare API | AI › Execute AI Model

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 } | 10 more...

Optional

An array of classification results for the input text

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai/run/$MODEL_NAME \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "result": [
    {
      "label": "label",
      "score": 0
    }
  ]
}

Authors

ai.authors

Methods

Author Search -> SinglePage<unknown>

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

Author Search

Finetunes

ai.finetunes

Methods

Create A New Finetune -> Envelope<{ id, created_at, model, 4 more... }>

post/accounts/{account_id}/ai/finetunes

Create a new Finetune

List Finetunes -> Envelope<{ id, created_at, model, 3 more... }>

get/accounts/{account_id}/ai/finetunes

List Finetunes

AI Finetunes

Assets

ai.finetunes.assets

Methods

Upload A Finetune Asset -> { success }

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

Upload a Finetune Asset

AI Finetunes

Public

ai.finetunes.public

Methods

List Public Finetunes -> SinglePage<{ id, created_at, model, 4 more... }>

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

List Public Finetunes

Models

ai.models

Methods

Model Search -> V4PagePaginationArray<unknown>

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

Model Search

AI Models

Schema

ai.models.schema

Methods

Get Model Schema -> Envelope<unknown>

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

Get Model Schema

Tasks

ai.tasks

Methods

Task Search -> SinglePage<unknown>

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

Task Search

To Markdown

ai.to_markdown

Methods

Convert Files Into Markdown -> SinglePage<{ data, format, mimeType, 2 more... }>

post/accounts/{account_id}/ai/tomarkdown

Convert Files into Markdown