API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

AI Search

AI SearchNamespaces

List namespaces.

client.AISearch.Namespaces.List(ctx, params) (*V4PagePaginationArray[NamespaceListResponse], error)

GET/accounts/{account_id}/ai-search/namespaces

Create namespace.

client.AISearch.Namespaces.New(ctx, params) (*NamespaceNewResponse, error)

POST/accounts/{account_id}/ai-search/namespaces

Read namespace.

client.AISearch.Namespaces.Read(ctx, name, query) (*NamespaceReadResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}

Update namespace.

client.AISearch.Namespaces.Update(ctx, name, params) (*NamespaceUpdateResponse, error)

PUT/accounts/{account_id}/ai-search/namespaces/{name}

Delete namespace.

client.AISearch.Namespaces.Delete(ctx, name, body) (*NamespaceDeleteResponse, error)

DELETE/accounts/{account_id}/ai-search/namespaces/{name}

Multi-Instance Search

client.AISearch.Namespaces.Search(ctx, name, params) (*NamespaceSearchResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/search

Multi-Instance Chat Completions

client.AISearch.Namespaces.ChatCompletions(ctx, name, params) (*NamespaceChatCompletionsResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/chat/completions

AI SearchNamespacesInstances

List instances.

client.AISearch.Namespaces.Instances.List(ctx, name, params) (*V4PagePaginationArray[NamespaceInstanceListResponse], error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances

Create new instances.

client.AISearch.Namespaces.Instances.New(ctx, name, params) (*NamespaceInstanceNewResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances

Read instances.

client.AISearch.Namespaces.Instances.Read(ctx, name, id, query) (*NamespaceInstanceReadResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}

Update instances.

client.AISearch.Namespaces.Instances.Update(ctx, name, id, params) (*NamespaceInstanceUpdateResponse, error)

PUT/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}

Delete instances.

client.AISearch.Namespaces.Instances.Delete(ctx, name, id, body) (*NamespaceInstanceDeleteResponse, error)

DELETE/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}

Stats

client.AISearch.Namespaces.Instances.Stats(ctx, name, id, query) (*NamespaceInstanceStatsResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/stats

Search

client.AISearch.Namespaces.Instances.Search(ctx, name, id, params) (*NamespaceInstanceSearchResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/search

Chat Completions

client.AISearch.Namespaces.Instances.ChatCompletions(ctx, name, id, params) (*NamespaceInstanceChatCompletionsResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions

AI SearchNamespacesInstancesJobs

List Jobs

client.AISearch.Namespaces.Instances.Jobs.List(ctx, name, id, params) (*V4PagePaginationArray[NamespaceInstanceJobListResponse], error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs

Create new job

client.AISearch.Namespaces.Instances.Jobs.New(ctx, name, id, params) (*NamespaceInstanceJobNewResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs

Get a Job Details

client.AISearch.Namespaces.Instances.Jobs.Get(ctx, name, id, jobID, query) (*NamespaceInstanceJobGetResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}

Change Job Status

client.AISearch.Namespaces.Instances.Jobs.Update(ctx, name, id, jobID, params) (*NamespaceInstanceJobUpdateResponse, error)

PATCH/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}

List Job Logs

client.AISearch.Namespaces.Instances.Jobs.Logs(ctx, name, id, jobID, params) (*[]NamespaceInstanceJobLogsResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/jobs/{job_id}/logs

AI SearchNamespacesInstancesItems

Items List.

client.AISearch.Namespaces.Instances.Items.List(ctx, name, id, params) (*V4PagePaginationArray[NamespaceInstanceItemListResponse], error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Upload Item.

client.AISearch.Namespaces.Instances.Items.Upload(ctx, name, id, params) (*NamespaceInstanceItemUploadResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Create or Update Item.

client.AISearch.Namespaces.Instances.Items.NewOrUpdate(ctx, name, id, params) (*NamespaceInstanceItemNewOrUpdateResponse, error)

PUT/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Get Item.

client.AISearch.Namespaces.Instances.Items.Get(ctx, name, id, itemID, query) (*NamespaceInstanceItemGetResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Sync Item.

client.AISearch.Namespaces.Instances.Items.Sync(ctx, name, id, itemID, params) (*NamespaceInstanceItemSyncResponse, error)

PATCH/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Delete Item.

client.AISearch.Namespaces.Instances.Items.Delete(ctx, name, id, itemID, body) (*NamespaceInstanceItemDeleteResponse, error)

DELETE/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Download Item Content.

client.AISearch.Namespaces.Instances.Items.Download(ctx, name, id, itemID, query) (*Response, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download

Item Logs.

client.AISearch.Namespaces.Instances.Items.Logs(ctx, name, id, itemID, params) (*[]NamespaceInstanceItemLogsResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs

List Item Chunks.

client.AISearch.Namespaces.Instances.Items.Chunks(ctx, name, id, itemID, params) (*[]NamespaceInstanceItemChunksResponse, error)

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks

AI SearchInstances

List instances.

client.AISearch.Instances.List(ctx, params) (*V4PagePaginationArray[InstanceListResponse], error)

GET/accounts/{account_id}/ai-search/instances

Create new instances.

client.AISearch.Instances.New(ctx, params) (*InstanceNewResponse, error)

POST/accounts/{account_id}/ai-search/instances

Read instances.

client.AISearch.Instances.Read(ctx, id, query) (*InstanceReadResponse, error)

GET/accounts/{account_id}/ai-search/instances/{id}

Update instances.

client.AISearch.Instances.Update(ctx, id, params) (*InstanceUpdateResponse, error)

PUT/accounts/{account_id}/ai-search/instances/{id}

Delete instances.

client.AISearch.Instances.Delete(ctx, id, body) (*InstanceDeleteResponse, error)

DELETE/accounts/{account_id}/ai-search/instances/{id}

Stats

client.AISearch.Instances.Stats(ctx, id, query) (*InstanceStatsResponse, error)

GET/accounts/{account_id}/ai-search/instances/{id}/stats

Search

client.AISearch.Instances.Search(ctx, id, params) (*InstanceSearchResponse, error)

POST/accounts/{account_id}/ai-search/instances/{id}/search

Chat Completions

client.AISearch.Instances.ChatCompletions(ctx, id, params) (*InstanceChatCompletionsResponse, error)

POST/accounts/{account_id}/ai-search/instances/{id}/chat/completions

AI SearchInstancesJobs

List Jobs

client.AISearch.Instances.Jobs.List(ctx, id, params) (*V4PagePaginationArray[InstanceJobListResponse], error)

GET/accounts/{account_id}/ai-search/instances/{id}/jobs

Create new job

client.AISearch.Instances.Jobs.New(ctx, id, params) (*InstanceJobNewResponse, error)

POST/accounts/{account_id}/ai-search/instances/{id}/jobs

Get a Job Details

client.AISearch.Instances.Jobs.Get(ctx, id, jobID, query) (*InstanceJobGetResponse, error)

GET/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}

List Job Logs

client.AISearch.Instances.Jobs.Logs(ctx, id, jobID, params) (*[]InstanceJobLogsResponse, error)

GET/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs

AI SearchTokens

List tokens.

client.AISearch.Tokens.List(ctx, params) (*V4PagePaginationArray[TokenListResponse], error)

GET/accounts/{account_id}/ai-search/tokens

Create new tokens.

client.AISearch.Tokens.New(ctx, params) (*TokenNewResponse, error)

POST/accounts/{account_id}/ai-search/tokens

Read tokens.

client.AISearch.Tokens.Read(ctx, id, query) (*TokenReadResponse, error)

GET/accounts/{account_id}/ai-search/tokens/{id}

Update tokens.

client.AISearch.Tokens.Update(ctx, id, params) (*TokenUpdateResponse, error)

PUT/accounts/{account_id}/ai-search/tokens/{id}

Delete tokens.

client.AISearch.Tokens.Delete(ctx, id, body) (*TokenDeleteResponse, error)

DELETE/accounts/{account_id}/ai-search/tokens/{id}