Cloudflare API | AI Gateway › Create A New Gateway

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai-gateway/gateways \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "id": "my-gateway",
          "cache_invalidate_on_update": true,
          "cache_ttl": 0,
          "collect_logs": true,
          "rate_limiting_interval": 0,
          "rate_limiting_limit": 0,
          "rate_limiting_technique": "fixed"
        }'

200Example

{
  "result": {
    "id": "my-gateway",
    "cache_invalidate_on_update": true,
    "cache_ttl": 0,
    "collect_logs": true,
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "rate_limiting_interval": 0,
    "rate_limiting_limit": 0,
    "rate_limiting_technique": "fixed",
    "authentication": true,
    "dlp": {
      "action": "BLOCK",
      "enabled": true,
      "profiles": [
        "string"
      ]
    },
    "is_default": true,
    "log_management": 10000,
    "log_management_strategy": "STOP_INSERTING",
    "logpush": true,
    "logpush_public_key": "xxxxxxxxxxxxxxxx",
    "otel": [
      {
        "authorization": "authorization",
        "headers": {
          "foo": "string"
        },
        "url": "url",
        "content_type": "json"
      }
    ],
    "store_id": "store_id",
    "stripe": {
      "authorization": "authorization",
      "usage_events": [
        {
          "payload": "payload"
        }
      ]
    },
    "workers_ai_billing_mode": "postpaid",
    "zdr": true
  },
  "success": true
}

Update A Gateway -> Envelope<{ id, cache_invalidate_on_update, cache_ttl, 18 more... }>

put/accounts/{account_id}/ai-gateway/gateways/{id}

Updates an existing AI Gateway dataset.

Delete A Gateway -> Envelope<{ id, cache_invalidate_on_update, cache_ttl, 18 more... }>

delete/accounts/{account_id}/ai-gateway/gateways/{id}

Deletes an AI Gateway dataset.

AI Gateway

Datasets

ai_gateway.datasets

Methods

List Datasets -> V4PagePaginationArray<{ id, created_at, enable, 4 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets

Lists all AI Gateway evaluator types configured for the account.

Fetch A Dataset -> Envelope<{ id, created_at, enable, 4 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}

Retrieves details for a specific AI Gateway dataset.

Create A New Dataset -> Envelope<{ id, created_at, enable, 4 more... }>

post/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets

Creates a new AI Gateway.

Update A Dataset -> Envelope<{ id, created_at, enable, 4 more... }>

put/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}

Updates an existing AI Gateway dataset.

Delete A Dataset -> Envelope<{ id, created_at, enable, 4 more... }>

delete/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}

Deletes an AI Gateway dataset.

AI Gateway

Dynamic Routing

ai_gateway.dynamic_routing

Methods

List All AI Gateway Dynamic Routes -> { data, success }

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes

List all AI Gateway Dynamic Routes.

Get An AI Gateway Dynamic Route -> Envelope<{ id, created_at, deployment, 5 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Get an AI Gateway Dynamic Route.

Create A New AI Gateway Dynamic Route -> Envelope<{ id, created_at, deployment, 5 more... }>

post/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes

Create a new AI Gateway Dynamic Route.

Update An AI Gateway Dynamic Route -> { route, success }

patch/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Update an AI Gateway Dynamic Route.

Delete An AI Gateway Dynamic Route -> Envelope<{ id, created_at, elements, 3 more... }>

delete/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Delete an AI Gateway Dynamic Route.

List All AI Gateway Dynamic Route Deployments -> { data, success }

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments

List all AI Gateway Dynamic Route Deployments.

Create A New AI Gateway Dynamic Route Deployment -> Envelope<{ id, created_at, elements, 3 more... }>

post/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments

Create a new AI Gateway Dynamic Route Deployment.

List All AI Gateway Dynamic Route Versions -> { data, success }

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions

List all AI Gateway Dynamic Route Versions.

Create A New AI Gateway Dynamic Route Version -> Envelope<{ id, created_at, elements, 3 more... }>

post/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions

Create a new AI Gateway Dynamic Route Version.

Get An AI Gateway Dynamic Route Version -> Envelope<{ id, active, created_at, 7 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions/{version_id}

Get an AI Gateway Dynamic Route Version.

AI Gateway

Evaluation Types

ai_gateway.evaluation_types

Methods

List Evaluators -> V4PagePaginationArray<{ id, created_at, description, 5 more... }>

get/accounts/{account_id}/ai-gateway/evaluation-types

List Evaluators

AI Gateway

Evaluations

ai_gateway.evaluations

Methods

List Evaluations -> V4PagePaginationArray<{ id, created_at, datasets, 6 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations

Lists all AI Gateway evaluator types configured for the account.

Fetch A Evaluation -> Envelope<{ id, created_at, datasets, 6 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}

Retrieves details for a specific AI Gateway dataset.

Create A New Evaluation -> Envelope<{ id, created_at, datasets, 6 more... }>

post/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations

Creates a new AI Gateway.

Delete A Evaluation -> Envelope<{ id, created_at, datasets, 6 more... }>

delete/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}

Deletes an AI Gateway dataset.

AI Gateway

Logs

ai_gateway.logs

Methods

List Gateway Logs -> V4PagePaginationArray<{ id, cached, created_at, 16 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs

List Gateway Logs

Get Gateway Log Detail -> Envelope<{ id, cached, created_at, 22 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}

Retrieves detailed information for a specific AI Gateway log entry.

Patch Gateway Log -> Envelope<unknown>

patch/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}

Updates metadata for an AI Gateway log entry.

Delete Gateway Logs -> { success }

delete/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs

Delete Gateway Logs

Get Gateway Log Request -> unknown

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/request

Retrieves the original request payload for an AI Gateway log entry.

Get Gateway Log Response -> unknown

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/response

Retrieves the response payload for an AI Gateway log entry.

AI Gateway

Provider Configs

ai_gateway.provider_configs

Methods

List Provider Configs -> V4PagePaginationArray<{ id, alias, default_config, 7 more... }>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs

Lists all AI Gateway evaluator types configured for the account.

Create A New Provider Configs -> Envelope<{ id, alias, default_config, 7 more... }>

post/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs

Creates a new AI Gateway.

AI Gateway

URLs

ai_gateway.urls

Methods

Get Gateway URL -> Envelope<string>

get/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/url/{provider}

Retrieves the endpoint URL for an AI Gateway.