1# AI Search API Reference
2 
3## Workers Binding
4 
5```typescript
6const answer = await env.AI.autorag("instance-name").aiSearch(options);
7const results = await env.AI.autorag("instance-name").search(options);
8const instances = await env.AI.autorag("_").listInstances();
9```
10 
11## aiSearch() Options
12 
13```typescript
14interface AiSearchOptions {
15  query: string;                          // User query
16  model: string;                          // Workers AI model ID
17  system_prompt?: string;                 // LLM instructions
18  rewrite_query?: boolean;                // Fix typos (default: false)
19  max_num_results?: number;               // Max chunks (default: 10)
20  ranking_options?: { score_threshold?: number }; // 0.0-1.0 (default: 0.3)
21  reranking?: { enabled: boolean; model: string };
22  stream?: boolean;                       // Stream response (default: false)
23  filters?: Filter;                       // Metadata filters
24  page?: string;                          // Pagination token
25}
26```
27 
28## Response
29 
30```typescript
31interface AiSearchResponse {
32  search_query: string;      // Query used (rewritten if enabled)
33  response: string;          // AI-generated answer
34  data: SearchResult[];      // Retrieved chunks
35  has_more: boolean;
36  next_page?: string;
37}
38 
39interface SearchResult {
40  id: string;
41  score: number;
42  content: string;
43  metadata: { filename: string; folder: string; timestamp: number };
44}
45```
46 
47## Filters
48 
49```typescript
50// Comparison
51{ column: "folder", operator: "gte", value: "docs/" }
52 
53// Compound
54{ operator: "and", filters: [
55  { column: "folder", operator: "gte", value: "docs/" },
56  { column: "timestamp", operator: "gte", value: 1704067200 }
57]}
58```
59 
60**Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`
61 
62**Built-in metadata:** `filename`, `folder`, `timestamp` (Unix seconds)
63 
64## Streaming
65 
66```typescript
67const stream = await env.AI.autorag("docs").aiSearch({ query, model, stream: true });
68return new Response(stream, { headers: { "Content-Type": "text/event-stream" } });
69```
70 
71## Error Types
72 
73| Error | Cause |
74|-------|-------|
75| `AutoRAGNotFoundError` | Instance doesn't exist |
76| `AutoRAGUnauthorizedError` | Invalid/missing token |
77| `AutoRAGValidationError` | Invalid parameters |
78 
79## REST API
80 
81```bash
82curl https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/autorag/rags/{NAME}/ai-search \
83  -H "Authorization: Bearer {TOKEN}" \
84  -d '{"query": "...", "model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast"}'
85```
86 
87Requires Service API token with "AI Search - Read" permission.
88