AI Search

Instances

ai_search.instances

Methods

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

List instances.

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

Create new instances.

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

Read instances.

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

Update instances.

Delete Instances -> Envelope<{ id, created_at, modified_at, 29 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

Stats

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

Search

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

Chat Completions

ai_search.instances.items

Methods

Items List -> V4PagePaginationArray<{ id, key, status, 3 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/items

Items List.

Get Item -> Envelope<{ id, key, status, 3 more... }>
get/accounts/{account_id}/ai-search/instances/{id}/items/{item_id}

Get Item.

ai_search.instances.jobs

Methods

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

List Jobs

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

Create new job

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

Get a Job Details

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

List Job Logs

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 new tokens.

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.