Skip to content
Cloudflare API
Start here
API Reference
AI Gateway
Custom Providers

Fetch a Account Provider

client.aiGateway.customProviders.get(stringid, CustomProviderGetParams { account_id } params, RequestOptionsoptions?): CustomProviderGetResponse { id, base_url, created_at, 12 more }
GET/accounts/{account_id}/ai-gateway/custom-providers/{id}

Retrieves details for a specific AI Gateway dataset.

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)
AI Gateway WriteAI Gateway Read
ParametersExpand Collapse
id: string
formatuuid
params: CustomProviderGetParams { account_id }
account_id: string
ReturnsExpand Collapse
CustomProviderGetResponse { id, base_url, created_at, 12 more }
id: string
formatuuid
base_url: string
formaturi
created_at: string
formatdate-time
modified_at: string
formatdate-time
name: string
slug: string
beta?: boolean
curl_example?: string
description?: string
enable?: boolean
headers?: string
maxLength8192
js_example?: string
position?: number

Fetch a Account Provider

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const customProvider = await client.aiGateway.customProviders.get(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { account_id: '3ebbcb006d4d46d7bb6a8c7f14676cb0' },
);

console.log(customProvider.id);
{
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "base_url": "https://example.com",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "slug": "slug",
    "beta": true,
    "curl_example": "curl_example",
    "description": "description",
    "enable": true,
    "headers": "headers",
    "js_example": "js_example",
    "link": "link",
    "logo": "logo",
    "position": 0
  },
  "success": true
}
Returns Examples
{
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "base_url": "https://example.com",
    "created_at": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "slug": "slug",
    "beta": true,
    "curl_example": "curl_example",
    "description": "description",
    "enable": true,
    "headers": "headers",
    "js_example": "js_example",
    "link": "link",
    "logo": "logo",
    "position": 0
  },
  "success": true
}