LogoCloudflare API

AI Search

ai_search

AI Search

Instances

ai_search.instances

Methods

List Instances -> V4PagePaginationArray<{ id, created_at, modified_at, 31 more... }>
get/accounts/{account_id}/ai-search/instances

List instances.

Create New Instances -> Envelope<{ id, created_at, modified_at, 31 more... }>
post/accounts/{account_id}/ai-search/instances

Create a new instances.

Read Instances -> Envelope<{ id, created_at, modified_at, 31 more... }>
get/accounts/{account_id}/ai-search/instances/{id}

Read instances.

Update Instances -> Envelope<{ id, created_at, modified_at, 31 more... }>
put/accounts/{account_id}/ai-search/instances/{id}

Update instances.

Delete Instances -> Envelope<{ id, created_at, modified_at, 31 more... }>
delete/accounts/{account_id}/ai-search/instances/{id}

Delete instances.

Stats -> Envelope<{ completed, error, file_embed_errors, 5 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/stats

Retrieves usage statistics for AI Search instances.

Search -> Envelope<{ chunks, search_query }>
post/accounts/{account_id}/ai-search/instances/{id}/search

Executes a semantic search query against an AI Search instance to find relevant indexed content.

Chat Completions -> { choices, chunks, id, 2 more... }
post/accounts/{account_id}/ai-search/instances/{id}/chat/completions

Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.

AI SearchInstances

Items

ai_search.instances.items

Methods

Items List -> V4PagePaginationArray<{ id, checksum, chunks_count, 9 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/items

Lists indexed items in an AI Search instance.

Get Item -> Envelope<{ id, checksum, chunks_count, 9 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/items/{item_id}

Retrieves a specific indexed item from an AI Search instance.

AI SearchInstances

Jobs

ai_search.instances.jobs

Methods

List Jobs -> V4PagePaginationArray<{ id, source, end_reason, 3 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/jobs

Lists indexing jobs for an AI Search instance.

Create New Job -> Envelope<{ id, source, end_reason, 3 more... }>
post/accounts/{account_id}/ai-search/instances/{id}/jobs

Creates a new indexing job for an AI Search instance.

Get A Job Details -> Envelope<{ id, source, end_reason, 3 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}

Retrieves details for a specific AI Search indexing job.

List Job Logs -> Envelope<Array<{ id, created_at, message, 1 more... }>>
get/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs

Lists log entries for an AI Search indexing job.

AI Search

Tokens

ai_search.tokens

Methods

List Tokens -> V4PagePaginationArray<{ id, cf_api_id, created_at, 6 more... }>
get/accounts/{account_id}/ai-search/tokens

List tokens.

Create New Tokens -> Envelope<{ id, cf_api_id, created_at, 6 more... }>
post/accounts/{account_id}/ai-search/tokens

Create a new tokens.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

path Parameters
account_id: string
Response fields
result: { id, cf_api_id, created_at, 6 more... }
success: boolean
Request example
200Example
Read Tokens -> Envelope<{ id, cf_api_id, created_at, 6 more... }>
get/accounts/{account_id}/ai-search/tokens/{id}

Read tokens.

Update Tokens -> Envelope<{ id, cf_api_id, created_at, 6 more... }>
put/accounts/{account_id}/ai-search/tokens/{id}

Update tokens.

Delete Tokens -> Envelope<{ id, cf_api_id, created_at, 6 more... }>
delete/accounts/{account_id}/ai-search/tokens/{id}

Delete tokens.