API Reference

AI

Models

Schema

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Model Schema

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

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

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers AI WriteWorkers AI Read

Path ParametersExpand Collapse

account_id: string

Query ParametersExpand Collapse

model: string

Model Name

ReturnsExpand Collapse

result: 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

success: boolean

Get Model Schema

HTTP

HTTP

TypeScript

Python

Go

Terraform

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai/models/schema \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

200 example

{
  "result": {
    "input": {
      "additionalProperties": true,
      "description": "JSON Schema definition for the model's input parameters",
      "type": "object"
    },
    "output": {
      "additionalProperties": true,
      "description": "JSON Schema definition for the model's output format",
      "type": "object"
    }
  },
  "success": true
}

Returns Examples

200 example

{
  "result": {
    "input": {
      "additionalProperties": true,
      "description": "JSON Schema definition for the model's input parameters",
      "type": "object"
    },
    "output": {
      "additionalProperties": true,
      "description": "JSON Schema definition for the model's output format",
      "type": "object"
    }
  },
  "success": true
}