Get Model Schema

client.AI.Models.Schema.Get(ctx, params) (*ModelSchemaGetResponse, error)

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

ParametersExpand Collapse

params ModelSchemaGetParams

AccountID param.Field[string]

Path param

Model param.Field[string]

Query param: Model Name

ReturnsExpand Collapse

type ModelSchemaGetResponse struct{…}

Input ModelSchemaGetResponseInput

AdditionalProperties bool

Description string

Type string

Output ModelSchemaGetResponseOutput

AdditionalProperties bool

Description string

Type string

Get Model Schema

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  schema, err := client.AI.Models.Schema.Get(context.TODO(), ai.ModelSchemaGetParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Model: cloudflare.F("model"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", schema.Input)
}

{
  "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

{
  "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
}