--- title: Create a gateway --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [AI Gateway](https://developers.cloudflare.com/api/typescript/resources/ai_gateway) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a gateway client.aiGateway.create(AIGatewayCreateParams {account\_id, id, cache\_invalidate\_on\_update, 23 more } params, RequestOptionsoptions?): [AIGatewayCreateResponse]() {id, cache\_invalidate\_on\_update, cache\_ttl, 25 more } POST/accounts/{account\_id}/ai-gateway/gateways Creates an AI Gateway in the account with the specified caching, rate limiting, logging, and authentication settings. The gateway ID appears in request URLs and must be unique within the account. ##### 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 Write` ##### ParametersExpand Collapse
params: AIGatewayCreateParams {account\_id, id, cache\_invalidate\_on\_update, 23 more } account\_id: string Path param Link to this property id: string Body param: Unique identifier of the AI Gateway within the account. maxLength64 minLength1 Link to this property cache\_invalidate\_on\_update: boolean Body param Link to this property cache\_ttl: number| null Body param minimum0 Link to this property collect\_logs: boolean Body param Link to this property rate\_limiting\_interval: number| null Body param minimum0 Link to this property rate\_limiting\_limit: number| null Body param minimum0 Link to this property authentication?: boolean Body param Link to this property byok\_only?: boolean Body param: Requires customer-provided provider credentials and prevents fallback to Unified Billing. Link to this property
dlp?: UnionMember0 {action, enabled, profiles } | UnionMember1 {enabled, policies } Body param One of the following:
UnionMember0 {action, enabled, profiles }
action: "BLOCK"| "FLAG" One of the following: "BLOCK" Link to this property "FLAG" Link to this property
Link to this property enabled: boolean Link to this property profiles: Array<string> Link to this property
Link to this property
UnionMember1 {enabled, policies } enabled: boolean Link to this property
policies: Array<Policy> id: string Link to this property
action: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
check: Array<"REQUEST"| "RESPONSE"> One of the following: "REQUEST" Link to this property "RESPONSE" Link to this property
Link to this property enabled: boolean Link to this property profiles: Array<string> Link to this property
Link to this property
Link to this property
Link to this property
guardrails?: Guardrails| null Body param
prompt: Prompt {P1, S1, S10, 11 more }
P1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S10?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S11?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S12?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S13?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S2?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S3?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S4?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S5?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S6?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S7?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S8?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S9?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
Link to this property
response: Response {P1, S1, S10, 11 more }
P1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S10?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S11?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S12?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S13?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S2?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S3?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S4?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S5?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S6?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S7?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S8?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S9?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
Link to this property
Link to this property log\_classification?: boolean Body param Link to this property log\_management?: number| null Body param maximum10000000 minimum10000 Link to this property
log\_management\_strategy?: "STOP\_INSERTING"| "DELETE\_OLDEST"| null Body param One of the following: "STOP\_INSERTING" Link to this property "DELETE\_OLDEST" Link to this property
Link to this property logpush?: boolean Body param Link to this property logpush\_public\_key?: string| null Body param maxLength1024 minLength16 Link to this property
otel?: Array<Otel>| null Body param headers: Record<string, string> Link to this property url: string formaturi maxLength2048 Link to this property authorization?: string maxLength256 Link to this property
content\_type?: "json"| "protobuf" One of the following: "json" Link to this property "protobuf" Link to this property
Link to this property
Link to this property
rate\_limiting\_technique?: "fixed"| "sliding"| null Body param One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
retry\_backoff?: "constant"| "linear"| "exponential"| null Body param: Backoff strategy for retry delays One of the following: "constant" Link to this property "linear" Link to this property "exponential" Link to this property
Link to this property retry\_delay?: number| null Body param: Delay between retry attempts in milliseconds (0-60000) maximum60000 minimum0 Link to this property retry\_max\_attempts?: number| null Body param: Maximum number of retry attempts for failed requests (1-5) maximum5 minimum1 Link to this property
spend\_limits?: SpendLimits| null Body param enabled?: boolean Link to this property
rules?: Array<Rule> limit: number exclusiveMinimum minimum0 Link to this property limitType: "cost" Link to this property window: number exclusiveMinimum minimum0 Link to this property id?: string minLength1 Link to this property enabled?: boolean Link to this property
metadata?: Record<string, Mode {mode } | UnionMember1 {mode, values } > One of the following:
Mode {mode } mode: "partition" Link to this property
Link to this property
UnionMember1 {mode, values } mode: "filter" Link to this property values: Array<string> Link to this property
Link to this property
Link to this property
model?: Model {mode, values } mode: "filter" Link to this property values: Array<string> Link to this property
Link to this property
provider?: Provider {mode, values } mode: "filter" Link to this property values: Array<string> Link to this property
Link to this property
technique?: "fixed"| "sliding" One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
Link to this property
Link to this property store\_id?: string| null Body param Link to this property
stripe?: Stripe| null Body param authorization: string Link to this property
usage\_events: Array<UsageEvent> payload: string Link to this property
Link to this property
Link to this property
workers\_ai\_billing\_mode?: "postpaid"| "unified" Body param: Controls how Workers AI inference calls routed through this gateway are billed. ‘postpaid’ bills the account directly through Workers AI; ‘unified’ deducts credits via AI Gateway using neuron-based pricing and delegates billing to AI Gateway. One of the following: "postpaid" Link to this property "unified" Link to this property
Link to this property zdr?: boolean Body param Link to this property
[Link to this property](<#(resource)%20ai_gateway%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
AIGatewayCreateResponse {id, cache\_invalidate\_on\_update, cache\_ttl, 25 more } id: string Unique identifier of the AI Gateway within the account. maxLength64 minLength1 Link to this property cache\_invalidate\_on\_update: boolean Link to this property cache\_ttl: number| null minimum0 Link to this property collect\_logs: boolean Link to this property created\_at: string formatdate-time Link to this property modified\_at: string formatdate-time Link to this property rate\_limiting\_interval: number| null minimum0 Link to this property rate\_limiting\_limit: number| null minimum0 Link to this property authentication?: boolean Link to this property byok\_only?: boolean Requires customer-provided provider credentials and prevents fallback to Unified Billing. Link to this property
dlp?: UnionMember0 {action, enabled, profiles } | UnionMember1 {enabled, policies } One of the following:
UnionMember0 {action, enabled, profiles }
action: "BLOCK"| "FLAG" One of the following: "BLOCK" Link to this property "FLAG" Link to this property
Link to this property enabled: boolean Link to this property profiles: Array<string> Link to this property
Link to this property
UnionMember1 {enabled, policies } enabled: boolean Link to this property
policies: Array<Policy> id: string Link to this property
action: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
check: Array<"REQUEST"| "RESPONSE"> One of the following: "REQUEST" Link to this property "RESPONSE" Link to this property
Link to this property enabled: boolean Link to this property profiles: Array<string> Link to this property
Link to this property
Link to this property
Link to this property
guardrails?: Guardrails| null
prompt: Prompt {P1, S1, S10, 11 more }
P1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S10?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S11?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S12?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S13?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S2?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S3?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S4?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S5?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S6?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S7?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S8?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S9?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
Link to this property
response: Response {P1, S1, S10, 11 more }
P1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S1?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S10?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S11?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S12?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S13?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S2?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S3?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S4?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S5?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S6?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S7?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S8?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
S9?: "FLAG"| "BLOCK" One of the following: "FLAG" Link to this property "BLOCK" Link to this property
Link to this property
Link to this property
Link to this property is\_default?: boolean Link to this property log\_classification?: boolean Link to this property log\_management?: number| null maximum10000000 minimum10000 Link to this property
log\_management\_strategy?: "STOP\_INSERTING"| "DELETE\_OLDEST"| null One of the following: "STOP\_INSERTING" Link to this property "DELETE\_OLDEST" Link to this property
Link to this property logpush?: boolean Link to this property logpush\_public\_key?: string| null maxLength1024 minLength16 Link to this property
otel?: Array<Otel>| null headers: Record<string, string> Link to this property url: string formaturi maxLength2048 Link to this property authorization?: string maxLength256 Link to this property
content\_type?: "json"| "protobuf" One of the following: "json" Link to this property "protobuf" Link to this property
Link to this property
Link to this property
rate\_limiting\_technique?: "fixed"| "sliding"| null One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
retry\_backoff?: "constant"| "linear"| "exponential"| null Backoff strategy for retry delays One of the following: "constant" Link to this property "linear" Link to this property "exponential" Link to this property
Link to this property retry\_delay?: number| null Delay between retry attempts in milliseconds (0-60000) maximum60000 minimum0 Link to this property retry\_max\_attempts?: number| null Maximum number of retry attempts for failed requests (1-5) maximum5 minimum1 Link to this property
spend\_limits?: SpendLimits| null enabled?: boolean Link to this property
rules?: Array<Rule> limit: number exclusiveMinimum minimum0 Link to this property limitType: "cost" Link to this property window: number exclusiveMinimum minimum0 Link to this property id?: string minLength1 Link to this property enabled?: boolean Link to this property
metadata?: Record<string, Mode {mode } | UnionMember1 {mode, values } > One of the following:
Mode {mode } mode: "partition" Link to this property
Link to this property
UnionMember1 {mode, values } mode: "filter" Link to this property values: Array<string> Link to this property
Link to this property
Link to this property
model?: Model {mode, values } mode: "filter" Link to this property values: Array<string> Link to this property
Link to this property
provider?: Provider {mode, values } mode: "filter" Link to this property values: Array<string> Link to this property
Link to this property
technique?: "fixed"| "sliding" One of the following: "fixed" Link to this property "sliding" Link to this property
Link to this property
Link to this property
Link to this property store\_id?: string| null Link to this property
stripe?: Stripe| null authorization: string Link to this property
usage\_events: Array<UsageEvent> payload: string Link to this property
Link to this property
Link to this property
workers\_ai\_billing\_mode?: "postpaid"| "unified" Controls how Workers AI inference calls routed through this gateway are billed. ‘postpaid’ bills the account directly through Workers AI; ‘unified’ deducts credits via AI Gateway using neuron-based pricing and delegates billing to AI Gateway. One of the following: "postpaid" Link to this property "unified" Link to this property
Link to this property zdr?: boolean Link to this property
[Link to this property](<#(resource)%20ai_gateway%20%3E%20(model)%20ai_gateway_create_response%20%3E%20(schema)>) ### Create a gateway TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const aiGateway = await client.aiGateway.create({ account_id: '3ebbcb006d4d46d7bb6a8c7f14676cb0', id: 'my-gateway', cache_invalidate_on_update: true, cache_ttl: 0, collect_logs: true, rate_limiting_interval: 0, rate_limiting_limit: 0, }); console.log(aiGateway.id); ``` 200 example ``` { "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, "authentication": true, "byok_only": true, "dlp": { "action": "BLOCK", "enabled": true, "profiles": [ "string" ] }, "guardrails": { "prompt": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" }, "response": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" } }, "is_default": true, "log_classification": true, "log_management": 10000, "log_management_strategy": "STOP_INSERTING", "logpush": true, "logpush_public_key": "xxxxxxxxxxxxxxxx", "otel": [ { "headers": { "foo": "string" }, "url": "https://example.com", "authorization": "authorization", "content_type": "json" } ], "rate_limiting_technique": "fixed", "retry_backoff": "constant", "retry_delay": 0, "retry_max_attempts": 1, "spend_limits": { "enabled": true, "rules": [ { "limit": 1, "limitType": "cost", "window": 1, "id": "x", "enabled": true, "metadata": { "foo": { "mode": "partition" } }, "model": { "mode": "filter", "values": [ "string" ] }, "provider": { "mode": "filter", "values": [ "string" ] }, "technique": "fixed" } ] }, "store_id": "store_id", "stripe": { "authorization": "authorization", "usage_events": [ { "payload": "payload" } ] }, "workers_ai_billing_mode": "postpaid", "zdr": true }, "success": true } ``` ##### Returns Examples 200 example ``` { "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, "authentication": true, "byok_only": true, "dlp": { "action": "BLOCK", "enabled": true, "profiles": [ "string" ] }, "guardrails": { "prompt": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" }, "response": { "P1": "FLAG", "S1": "FLAG", "S10": "FLAG", "S11": "FLAG", "S12": "FLAG", "S13": "FLAG", "S2": "FLAG", "S3": "FLAG", "S4": "FLAG", "S5": "FLAG", "S6": "FLAG", "S7": "FLAG", "S8": "FLAG", "S9": "FLAG" } }, "is_default": true, "log_classification": true, "log_management": 10000, "log_management_strategy": "STOP_INSERTING", "logpush": true, "logpush_public_key": "xxxxxxxxxxxxxxxx", "otel": [ { "headers": { "foo": "string" }, "url": "https://example.com", "authorization": "authorization", "content_type": "json" } ], "rate_limiting_technique": "fixed", "retry_backoff": "constant", "retry_delay": 0, "retry_max_attempts": 1, "spend_limits": { "enabled": true, "rules": [ { "limit": 1, "limitType": "cost", "window": 1, "id": "x", "enabled": true, "metadata": { "foo": { "mode": "partition" } }, "model": { "mode": "filter", "values": [ "string" ] }, "provider": { "mode": "filter", "values": [ "string" ] }, "technique": "fixed" } ] }, "store_id": "store_id", "stripe": { "authorization": "authorization", "usage_events": [ { "payload": "payload" } ] }, "workers_ai_billing_mode": "postpaid", "zdr": true }, "success": true } ```