Skip to content

try-works/role-model / .agents/skills/cloudflare

cloudflare

Unverified

Comprehensive Cloudflare platform skill covering Workers, Pages, storage (KV, D1, R2), AI (Workers AI, Vectorize, Agents SDK), feature flags (Flagship), networking (Tunnel, Spectrum), security (WAF, DDoS), and infrastructure-as-code (Terraform, Pulumi). Use for any Cloudflare development task. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.

FileKindSize
SKILL.mdskill md8.8 KB
references/agents-sdk/README.mdmarkdown2.7 KB
references/agents-sdk/api.mdmarkdown5.7 KB
references/agents-sdk/configuration.mdmarkdown3.5 KB
references/agents-sdk/gotchas.mdmarkdown5.0 KB
references/agents-sdk/patterns.mdmarkdown5.5 KB
references/ai-gateway/README.mdmarkdown6.2 KB
references/ai-gateway/configuration.mdmarkdown2.9 KB
references/ai-gateway/dynamic-routing.mdmarkdown1.8 KB
references/ai-gateway/features.mdmarkdown2.7 KB
references/ai-gateway/sdk-integration.mdmarkdown2.6 KB
references/ai-gateway/troubleshooting.mdmarkdown2.4 KB
references/ai-search/README.mdmarkdown4.4 KB
references/ai-search/api.mdmarkdown2.5 KB
references/ai-search/configuration.mdmarkdown1.7 KB
references/ai-search/gotchas.mdmarkdown2.1 KB
references/ai-search/patterns.mdmarkdown2.0 KB
references/analytics-engine/README.mdmarkdown3.3 KB
references/analytics-engine/api.mdmarkdown3.1 KB
references/analytics-engine/configuration.mdmarkdown2.3 KB
references/analytics-engine/gotchas.mdmarkdown2.0 KB
references/analytics-engine/patterns.mdmarkdown2.3 KB
references/api-shield/README.mdmarkdown1.8 KB
references/api-shield/api.mdmarkdown3.8 KB
references/api-shield/configuration.mdmarkdown4.9 KB
references/api-shield/gotchas.mdmarkdown4.8 KB
references/api-shield/patterns.mdmarkdown5.7 KB
references/api/README.mdmarkdown2.4 KB
references/api/api.mdmarkdown4.2 KB
references/api/configuration.mdmarkdown3.7 KB
references/api/gotchas.mdmarkdown5.3 KB
references/api/patterns.mdmarkdown4.5 KB
references/argo-smart-routing/README.mdmarkdown4.0 KB
references/argo-smart-routing/api.mdmarkdown6.4 KB
references/argo-smart-routing/configuration.mdmarkdown4.4 KB
references/argo-smart-routing/gotchas.mdmarkdown4.2 KB
references/argo-smart-routing/patterns.mdmarkdown3.0 KB
references/artifacts/README.mdmarkdown3.7 KB
references/artifacts/api.mdmarkdown5.0 KB
references/artifacts/configuration.mdmarkdown3.1 KB
references/bindings/README.mdmarkdown3.9 KB
references/bindings/api.mdmarkdown5.1 KB
references/bindings/configuration.mdmarkdown4.4 KB
references/bindings/gotchas.mdmarkdown6.0 KB
references/bindings/patterns.mdmarkdown4.9 KB
references/bot-management/README.mdmarkdown3.7 KB
references/bot-management/api.mdmarkdown5.7 KB
references/bot-management/configuration.mdmarkdown5.6 KB
references/bot-management/gotchas.mdmarkdown5.5 KB
references/bot-management/patterns.mdmarkdown4.9 KB
references/browser-rendering/README.mdmarkdown3.0 KB
references/browser-rendering/api.mdmarkdown2.9 KB
references/browser-rendering/configuration.mdmarkdown1.8 KB
references/browser-rendering/gotchas.mdmarkdown2.5 KB
references/browser-rendering/patterns.mdmarkdown2.6 KB
references/c3/README.mdmarkdown3.3 KB
references/c3/api.mdmarkdown2.2 KB
references/c3/configuration.mdmarkdown1.6 KB
references/c3/gotchas.mdmarkdown2.3 KB
references/c3/patterns.mdmarkdown2.2 KB
references/cache-reserve/README.mdmarkdown5.5 KB
references/cache-reserve/api.mdmarkdown5.9 KB
references/cache-reserve/configuration.mdmarkdown3.6 KB
references/cache-reserve/gotchas.mdmarkdown5.7 KB
references/cache-reserve/patterns.mdmarkdown6.1 KB
references/containers/README.mdmarkdown3.4 KB
references/containers/api.mdmarkdown4.2 KB
references/containers/configuration.mdmarkdown5.3 KB
references/containers/gotchas.mdmarkdown4.4 KB
references/containers/patterns.mdmarkdown4.8 KB
references/cron-triggers/README.mdmarkdown2.9 KB
references/cron-triggers/api.mdmarkdown5.7 KB
references/cron-triggers/configuration.mdmarkdown4.2 KB
references/cron-triggers/gotchas.mdmarkdown6.2 KB
references/cron-triggers/patterns.mdmarkdown6.8 KB
references/d1/README.mdmarkdown4.6 KB
references/d1/api.mdmarkdown6.6 KB
references/d1/configuration.mdmarkdown5.5 KB
references/d1/gotchas.mdmarkdown4.2 KB
references/d1/patterns.mdmarkdown7.1 KB
references/ddos/README.mdmarkdown2.0 KB
references/ddos/api.mdmarkdown4.1 KB
references/ddos/configuration.mdmarkdown2.9 KB
references/ddos/gotchas.mdmarkdown3.8 KB
references/ddos/patterns.mdmarkdown5.5 KB
references/do-storage/README.mdmarkdown2.7 KB
references/do-storage/api.mdmarkdown3.5 KB
references/do-storage/configuration.mdmarkdown2.2 KB
references/do-storage/gotchas.mdmarkdown5.1 KB
references/do-storage/patterns.mdmarkdown6.0 KB
references/do-storage/testing.mdmarkdown4.8 KB
references/durable-objects/README.mdmarkdown6.5 KB
references/durable-objects/api.mdmarkdown6.0 KB
references/durable-objects/configuration.mdmarkdown4.2 KB
references/durable-objects/gotchas.mdmarkdown7.1 KB
references/durable-objects/patterns.mdmarkdown6.5 KB
references/email-routing/README.mdmarkdown3.4 KB
references/email-routing/api.mdmarkdown5.2 KB
references/email-routing/configuration.mdmarkdown3.5 KB
references/email-routing/gotchas.mdmarkdown4.0 KB
references/email-routing/patterns.mdmarkdown5.4 KB
references/email-workers/README.mdmarkdown5.3 KB
references/email-workers/api.mdmarkdown5.9 KB
references/email-workers/configuration.mdmarkdown2.7 KB
references/email-workers/gotchas.mdmarkdown3.0 KB
references/email-workers/patterns.mdmarkdown2.7 KB
references/flagship/README.mdmarkdown3.6 KB
references/flagship/api.mdmarkdown11.5 KB
references/flagship/configuration.mdmarkdown4.7 KB
references/flagship/gotchas.mdmarkdown6.2 KB
references/flagship/patterns.mdmarkdown13.7 KB
references/graphql-api/README.mdmarkdown7.6 KB
references/graphql-api/api.mdmarkdown5.6 KB
references/graphql-api/configuration.mdmarkdown4.6 KB
references/graphql-api/gotchas.mdmarkdown4.7 KB
references/graphql-api/patterns.mdmarkdown6.4 KB
references/hyperdrive/README.mdmarkdown2.8 KB
references/hyperdrive/api.mdmarkdown3.8 KB
references/hyperdrive/configuration.mdmarkdown3.8 KB
references/hyperdrive/gotchas.mdmarkdown3.8 KB
references/hyperdrive/patterns.mdmarkdown5.8 KB
references/images/README.mdmarkdown2.8 KB
references/images/api.mdmarkdown2.5 KB
references/images/configuration.mdmarkdown4.0 KB
references/images/gotchas.mdmarkdown2.4 KB
references/images/patterns.mdmarkdown3.5 KB
references/kv/README.mdmarkdown2.8 KB
references/kv/api.mdmarkdown4.2 KB
references/kv/configuration.mdmarkdown3.0 KB
references/kv/gotchas.mdmarkdown4.3 KB
references/kv/patterns.mdmarkdown4.6 KB
references/miniflare/README.mdmarkdown2.9 KB
references/miniflare/api.mdmarkdown4.5 KB
references/miniflare/configuration.mdmarkdown3.4 KB
references/miniflare/gotchas.mdmarkdown3.6 KB
references/miniflare/patterns.mdmarkdown4.2 KB
references/network-interconnect/README.mdmarkdown3.2 KB
references/network-interconnect/api.mdmarkdown5.5 KB
references/network-interconnect/configuration.mdmarkdown4.2 KB
references/network-interconnect/gotchas.mdmarkdown5.4 KB
references/network-interconnect/patterns.mdmarkdown3.9 KB
references/observability/README.mdmarkdown3.9 KB
references/observability/api.mdmarkdown3.4 KB
references/observability/configuration.mdmarkdown3.5 KB
references/observability/gotchas.mdmarkdown3.7 KB
references/observability/patterns.mdmarkdown2.4 KB
references/pages-functions/README.mdmarkdown3.2 KB
references/pages-functions/api.mdmarkdown4.6 KB
references/pages-functions/configuration.mdmarkdown2.9 KB
references/pages-functions/gotchas.mdmarkdown3.8 KB
references/pages-functions/patterns.mdmarkdown4.1 KB
references/pages/README.mdmarkdown2.8 KB
references/pages/api.mdmarkdown5.8 KB
references/pages/configuration.mdmarkdown5.7 KB
references/pages/gotchas.mdmarkdown7.9 KB
references/pages/patterns.mdmarkdown5.9 KB
references/pipelines/README.mdmarkdown4.2 KB
references/pipelines/api.mdmarkdown4.9 KB
references/pipelines/configuration.mdmarkdown6.0 KB
references/pipelines/gotchas.mdmarkdown3.0 KB
references/pipelines/patterns.mdmarkdown4.6 KB
references/pulumi/README.mdmarkdown3.2 KB
references/pulumi/api.mdmarkdown5.6 KB
references/pulumi/configuration.mdmarkdown5.5 KB
references/pulumi/gotchas.mdmarkdown6.4 KB
references/pulumi/patterns.mdmarkdown6.8 KB
references/queues/README.mdmarkdown3.0 KB
references/queues/api.mdmarkdown5.4 KB
references/queues/configuration.mdmarkdown3.7 KB
references/queues/gotchas.mdmarkdown7.1 KB
references/queues/patterns.mdmarkdown5.4 KB
references/r2-data-catalog/README.mdmarkdown3.9 KB
references/r2-data-catalog/api.mdmarkdown5.5 KB
references/r2-data-catalog/configuration.mdmarkdown3.9 KB
references/r2-data-catalog/gotchas.mdmarkdown3.2 KB
references/r2-data-catalog/patterns.mdmarkdown5.2 KB
references/r2-sql/README.mdmarkdown3.2 KB
references/r2-sql/api.mdmarkdown4.8 KB
references/r2-sql/configuration.mdmarkdown1.6 KB
references/r2-sql/gotchas.mdmarkdown1.9 KB
references/r2-sql/patterns.mdmarkdown4.3 KB
references/r2/README.mdmarkdown2.8 KB
references/r2/api.mdmarkdown5.5 KB
references/r2/configuration.mdmarkdown3.6 KB
references/r2/gotchas.mdmarkdown4.9 KB
references/r2/patterns.mdmarkdown5.7 KB
references/realtime-sfu/README.mdmarkdown3.0 KB
references/realtime-sfu/api.mdmarkdown3.7 KB
references/realtime-sfu/configuration.mdmarkdown3.4 KB
references/realtime-sfu/gotchas.mdmarkdown4.8 KB
references/realtime-sfu/patterns.mdmarkdown5.3 KB
references/realtimekit/README.mdmarkdown4.0 KB
references/realtimekit/api.mdmarkdown8.2 KB
references/realtimekit/configuration.mdmarkdown5.1 KB
references/realtimekit/gotchas.mdmarkdown6.7 KB
references/realtimekit/patterns.mdmarkdown7.5 KB
references/sandbox/README.mdmarkdown3.0 KB
references/sandbox/api.mdmarkdown4.9 KB
references/sandbox/configuration.mdmarkdown3.3 KB
references/sandbox/gotchas.mdmarkdown5.3 KB

references/ai-gateway/README.md

View on GitHub
# Cloudflare AI Gateway

Expert guidance for implementing Cloudflare AI Gateway - a universal gateway for AI model providers with analytics, caching, rate limiting, and routing capabilities.

## When to Use This Reference

- Setting up AI Gateway for any AI provider (OpenAI, Anthropic, Workers AI, etc.)
- Implementing caching, rate limiting, or request retry/fallback
- Configuring dynamic routing with A/B testing or model fallbacks
- Managing provider API keys securely with BYOK
- Adding security features (guardrails, DLP)
- Setting up observability with logging and custom metadata
- Debugging AI Gateway requests or optimizing configurations

## Quick Start

**What's your setup?**

- **Using Vercel AI SDK** → Pattern 1 (recommended) - see [sdk-integration.md](./sdk-integration.md)
- **Using OpenAI SDK** → Pattern 2 - see [sdk-integration.md](./sdk-integration.md)
- **Cloudflare Worker + Workers AI** → Pattern 3 - see [sdk-integration.md](./sdk-integration.md)
- **Direct HTTP (any language)** → Pattern 4 - see [configuration.md](./configuration.md)
- **Framework (LangChain, etc.)** → See [sdk-integration.md](./sdk-integration.md)

## Pattern 1: Vercel AI SDK (Recommended)

Most modern pattern using official `ai-gateway-provider` package with automatic fallbacks.

```typescript
import { createAiGateway } from 'ai-gateway-provider';
import { createOpenAI } from '@ai-sdk/openai';
import { generateText } from 'ai';

const gateway = createAiGateway({
  accountId: process.env.CF_ACCOUNT_ID,
  gateway: process.env.CF_GATEWAY_ID,
});

const openai = createOpenAI({ 
  apiKey: process.env.OPENAI_API_KEY 
});

// Single model
const { text } = await generateText({
  model: gateway(openai('gpt-4o')),
  prompt: 'Hello'
});

// Automatic fallback array
const { text } = await generateText({
  model: gateway([
    openai('gpt-4o'),              // Try first
    anthropic('claude-sonnet-4-5'), // Fallback
  ]),
  prompt: 'Hello'
});
```

**Install:** `npm install ai-gateway-provider ai @ai-sdk/openai @ai-sdk/anthropic`

## Pattern 2: OpenAI SDK

Drop-in replacement for OpenAI API with multi-provider support.

```typescript
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
  baseURL: `https://gateway.ai.cloudflare.com/v1/${accountId}/${gatewayId}/compat`,
  defaultHeaders: {
    'cf-aig-authorization': `Bearer ${cfToken}` // For authenticated gateways
  }
});

// Switch providers by changing model format: {provider}/{model}
const response = await client.chat.completions.create({
  model: 'openai/gpt-4o', // or 'anthropic/claude-sonnet-4-5'
  messages: [{ role: 'user', content: 'Hello!' }]
});
```

## Pattern 3: Workers AI Binding

For Cloudflare Workers using Workers AI.

```typescript
export default {
  async fetch(request, env, ctx) {
    const response = await env.AI.run(
      '@cf/meta/llama-3-8b-instruct',
      { messages: [{ role: 'user', content: 'Hello!' }] },
      { 
        gateway: { 
          id: 'my-gateway',
          metadata: { userId: '123', team: 'engineering' }
        } 
      }
    );
    
    return Response.json(response);
  }
};
```

## Headers Quick Reference

| Header | Purpose | Example | Notes |
|--------|---------|---------|-------|
| `cf-aig-authorization` | Gateway auth | `Bearer {token}` | Required for authenticated gateways |
| `cf-aig-metadata` | Tracking | `{"userId":"x"}` | Max 5 entries, flat structure |
| `cf-aig-cache-ttl` | Cache duration | `3600` | Seconds, min 60, max 2592000 (30 days) |
| `cf-aig-skip-cache` | Bypass cache | `true` | - |
| `cf-aig-cache-key` | Custom cache key | `my-key` | Must be unique per response |
| `cf-aig-collect-log` | Skip logging | `false` | Default: true |
| `cf-aig-cache-status` | Cache hit/miss | Response only | `HIT` or `MISS` |

## In This Reference

| File | Purpose |
|------|---------|
| [sdk-integration.md](./sdk-integration.md) | Vercel AI SDK, OpenAI SDK, Workers binding patterns |
| [configuration.md](./configuration.md) | Dashboard setup, wrangler, API tokens |
| [features.md](./features.md) | Caching, rate limits, guardrails, DLP, BYOK, unified billing |
| [dynamic-routing.md](./dynamic-routing.md) | Fallbacks, A/B testing, conditional routing |
| [troubleshooting.md](./troubleshooting.md) | Debugging, errors, observability, gotchas |

## Reading Order

| Task | Files |
|------|-------|
| First-time setup | README + [configuration.md](./configuration.md) |
| SDK integration | README + [sdk-integration.md](./sdk-integration.md) |
| Enable caching | README + [features.md](./features.md) |
| Setup fallbacks | README + [dynamic-routing.md](./dynamic-routing.md) |
| Debug errors | README + [troubleshooting.md](./troubleshooting.md) |

## Architecture

AI Gateway acts as a proxy between your application and AI providers:

```
Your App → AI Gateway → AI Provider (OpenAI, Anthropic, etc.)
         ↓
    Analytics, Caching, Rate Limiting, Logging
```

**Key URL patterns:**
- Unified API (OpenAI-compatible): `https://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id}/compat/chat/completions`
- Provider-specific: `https://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id}/{provider}/{endpoint}`
- Dynamic routes: Use route name instead of model: `dynamic/{route-name}`

## Gateway Types

1. **Unauthenticated Gateway**: Open access (not recommended for production)
2. **Authenticated Gateway**: Requires `cf-aig-authorization` header with Cloudflare API token (recommended)

## Provider Authentication Options

1. **Unified Billing**: Use AI Gateway billing to pay for inference (keyless mode - no provider API key needed)
2. **BYOK (Store Keys)**: Store provider API keys in Cloudflare dashboard
3. **Request Headers**: Include provider API key in each request

## Related Skills

- [Workers AI](../workers-ai/README.md) - For `env.AI.run()` details
- [Agents SDK](../agents-sdk/README.md) - For stateful AI patterns
- [Vectorize](../vectorize/README.md) - For RAG patterns with embeddings

## Resources

- [Official Docs](https://developers.cloudflare.com/ai-gateway/)
- [API Reference](https://developers.cloudflare.com/api/resources/ai_gateway/)
- [Provider Guides](https://developers.cloudflare.com/ai-gateway/usage/providers/)
- [Discord Community](https://discord.cloudflare.com)
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall