Skip to main content

Quick Start

Get started with Workers AI in under 2 minutes:
from portkey_ai import Portkey

# 1. Install: pip install portkey-ai
# 2. Add @workers-ai provider in model catalog
# 3. Use it:

portkey = Portkey(api_key="PORTKEY_API_KEY")

response = portkey.chat.completions.create(
    model="@workers-ai/@cf/meta/llama-3.2-3b-instruct",
    messages=[{"role": "user", "content": "Hello!"}]
)

print(response.choices[0].message.content)
import Portkey from 'portkey-ai'

// 1. Install: npm install portkey-ai
// 2. Add @workers-ai provider in model catalog
// 3. Use it:

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY"
})

const response = await portkey.chat.completions.create({
    model: "@workers-ai/@cf/meta/llama-3.2-3b-instruct",
    messages: [{ role: "user", content: "Hello!" }]
})

console.log(response.choices[0].message.content)
from openai import OpenAI
from portkey_ai import PORTKEY_GATEWAY_URL

# 1. Install: pip install openai portkey-ai
# 2. Add @workers-ai provider in model catalog
# 3. Use it:

client = OpenAI(
    api_key="PORTKEY_API_KEY",  # Portkey API key
    base_url=PORTKEY_GATEWAY_URL
)

response = client.chat.completions.create(
    model="@workers-ai/@cf/meta/llama-3.2-3b-instruct",
    messages=[{"role": "user", "content": "Hello!"}]
)

print(response.choices[0].message.content)
import OpenAI from "openai"
import { PORTKEY_GATEWAY_URL } from "portkey-ai"

// 1. Install: npm install openai portkey-ai
// 2. Add @workers-ai provider in model catalog
// 3. Use it:

const client = new OpenAI({
    apiKey: "PORTKEY_API_KEY",  // Portkey API key
    baseURL: PORTKEY_GATEWAY_URL
})

const response = await client.chat.completions.create({
    model: "@workers-ai/@cf/meta/llama-3.2-3b-instruct",
    messages: [{ role: "user", content: "Hello!" }]
})

console.log(response.choices[0].message.content)
# 1. Add @workers-ai provider in model catalog
# 2. Use it:

curl https://api.portkey.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "model": "@workers-ai/@cf/meta/llama-3.2-3b-instruct",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

Add Provider in Model Catalog

Before making requests, add Workers AI to your Model Catalog:
  1. Go to Model Catalog → Add Provider
  2. Select Workers AI
  3. Enter your Cloudflare API key
  4. Name your provider (e.g., workers-ai)

Complete Setup Guide

See all setup options and detailed configuration instructions

Workers AI Capabilities

Image Generation

Workers AI supports image generation with various models:
from portkey_ai import Portkey

portkey = Portkey(api_key="PORTKEY_API_KEY", provider="@workers-ai")

image = portkey.images.generate(
    model="@cf/stabilityai/stable-diffusion-xl-base-1.0",
    prompt="A beautiful sunset over mountains"
)

print(image.data[0].url)
import Portkey from 'portkey-ai';

const portkey = new Portkey({
    apiKey: 'PORTKEY_API_KEY',
    provider: '@workers-ai'
});

const image = await portkey.images.generate({
    model: "@cf/stabilityai/stable-diffusion-xl-base-1.0",
    prompt: "A beautiful sunset over mountains"
});

console.log(image.data[0].url);

Supported Models

Cloudflare Workers AI provides serverless AI inference with various models: Chat Models:
  • @cf/meta/llama-3.2-3b-instruct
  • @cf/meta/llama-3.1-8b-instruct
  • @cf/mistral/mistral-7b-instruct-v0.1
Image Generation Models:
  • @cf/stabilityai/stable-diffusion-xl-base-1.0
Check Cloudflare Workers AI documentation for the complete model list.

Next Steps

Gateway Configs

Add fallbacks, load balancing, and more

Observability

Monitor and trace your Workers AI requests

Prompt Library

Manage and version your prompts

Caching

Cache responses at the edge
For complete SDK documentation:

SDK Reference

Complete Portkey SDK documentation
Last modified on April 2, 2026