List AI Search instances.

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

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

List all AI Search instances in the account.

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params InstanceListParams

AccountID param.Field[string]

Path param

Namespace param.Field[string]Optional

Query param: Filter by namespace.

OrderBy param.Field[InstanceListParamsOrderBy]Optional

Query param: Field to order results by.

const InstanceListParamsOrderByCreatedAt InstanceListParamsOrderBy = "created_at"

OrderByDirection param.Field[InstanceListParamsOrderByDirection]Optional

Query param: Order direction.

const InstanceListParamsOrderByDirectionAsc InstanceListParamsOrderByDirection = "asc"

const InstanceListParamsOrderByDirectionDesc InstanceListParamsOrderByDirection = "desc"

Page param.Field[int64]Optional

Query param: Page number (1-indexed).

minimum1

PerPage param.Field[int64]Optional

Query param: Number of results per page.

maximum100

minimum1

Search param.Field[string]Optional

Query param: Filter instances whose id contains this string (case-insensitive).

maxLength64

ReturnsExpand Collapse

type InstanceListResponse struct{…}

ID string

AIGatewayID string

AISearchModel string

Cache bool

CacheThreshold InstanceListResponseCacheThreshold

One of the following:

const InstanceListResponseCacheThresholdSuperStrictMatch InstanceListResponseCacheThreshold = "super_strict_match"

const InstanceListResponseCacheThresholdCloseEnough InstanceListResponseCacheThreshold = "close_enough"

const InstanceListResponseCacheThresholdFlexibleFriend InstanceListResponseCacheThreshold = "flexible_friend"

const InstanceListResponseCacheThresholdAnythingGoes InstanceListResponseCacheThreshold = "anything_goes"

CacheTTL InstanceListResponseCacheTTL

One of the following:

const InstanceListResponseCacheTTL600 InstanceListResponseCacheTTL = 600

const InstanceListResponseCacheTTL1800 InstanceListResponseCacheTTL = 1800

const InstanceListResponseCacheTTL3600 InstanceListResponseCacheTTL = 3600

const InstanceListResponseCacheTTL7200 InstanceListResponseCacheTTL = 7200

const InstanceListResponseCacheTTL21600 InstanceListResponseCacheTTL = 21600

const InstanceListResponseCacheTTL43200 InstanceListResponseCacheTTL = 43200

const InstanceListResponseCacheTTL86400 InstanceListResponseCacheTTL = 86400

const InstanceListResponseCacheTTL172800 InstanceListResponseCacheTTL = 172800

const InstanceListResponseCacheTTL259200 InstanceListResponseCacheTTL = 259200

const InstanceListResponseCacheTTL518400 InstanceListResponseCacheTTL = 518400

Chunk bool

ChunkOverlap float64

ChunkSize float64

CreatedAt Time

formatdate-time

CreatedBy string

CustomMetadata []InstanceListResponseCustomMetadata

DataType InstanceListResponseCustomMetadataDataType

One of the following:

const InstanceListResponseCustomMetadataDataTypeText InstanceListResponseCustomMetadataDataType = "text"

const InstanceListResponseCustomMetadataDataTypeNumber InstanceListResponseCustomMetadataDataType = "number"

const InstanceListResponseCustomMetadataDataTypeBoolean InstanceListResponseCustomMetadataDataType = "boolean"

const InstanceListResponseCustomMetadataDataTypeDatetime InstanceListResponseCustomMetadataDataType = "datetime"

FieldName string

EmbeddingModel string

Enable bool

EngineVersion float64

FusionMethod InstanceListResponseFusionMethod

One of the following:

const InstanceListResponseFusionMethodMax InstanceListResponseFusionMethod = "max"

const InstanceListResponseFusionMethodRrf InstanceListResponseFusionMethod = "rrf"

HybridSearchEnabled bool

IndexMethod InstanceListResponseIndexMethod

Keyword bool

Vector bool

IndexingOptions InstanceListResponseIndexingOptions

KeywordTokenizer InstanceListResponseIndexingOptionsKeywordTokenizerOptional

One of the following:

const InstanceListResponseIndexingOptionsKeywordTokenizerPorter InstanceListResponseIndexingOptionsKeywordTokenizer = "porter"

const InstanceListResponseIndexingOptionsKeywordTokenizerTrigram InstanceListResponseIndexingOptionsKeywordTokenizer = "trigram"

LastActivity Time

formatdate-time

MaxNumResults float64

Metadata InstanceListResponseMetadata

CreatedFromAISearchWizard boolOptional

WorkerDomain stringOptional

ModifiedAt Time

formatdate-time

ModifiedBy string

Namespace string

Paused bool

PublicEndpointID string

PublicEndpointParams InstanceListResponsePublicEndpointParams

AuthorizedHosts []stringOptional

ChatCompletionsEndpoint InstanceListResponsePublicEndpointParamsChatCompletionsEndpointOptional

Disabled boolOptional

CustomDomains []stringOptional

DefaultDomainEnabled boolOptional

Enabled boolOptional

Mcp InstanceListResponsePublicEndpointParamsMcpOptional

Description stringOptional

Disabled boolOptional

RateLimit InstanceListResponsePublicEndpointParamsRateLimitOptional

PeriodMs int64Optional

maximum3600000

minimum60000

Requests int64Optional

minimum1

Technique InstanceListResponsePublicEndpointParamsRateLimitTechniqueOptional

One of the following:

const InstanceListResponsePublicEndpointParamsRateLimitTechniqueFixed InstanceListResponsePublicEndpointParamsRateLimitTechnique = "fixed"

const InstanceListResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceListResponsePublicEndpointParamsRateLimitTechnique = "sliding"

SearchEndpoint InstanceListResponsePublicEndpointParamsSearchEndpointOptional

Disabled boolOptional

Reranking bool

RerankingModel string

RetrievalOptions InstanceListResponseRetrievalOptions

BoostBy []InstanceListResponseRetrievalOptionsBoostByOptional

Field string

maxLength64

minLength1

DataType InstanceListResponseRetrievalOptionsBoostByDataTypeOptional

One of the following:

const InstanceListResponseRetrievalOptionsBoostByDataTypeNumber InstanceListResponseRetrievalOptionsBoostByDataType = "number"

const InstanceListResponseRetrievalOptionsBoostByDataTypeDatetime InstanceListResponseRetrievalOptionsBoostByDataType = "datetime"

const InstanceListResponseRetrievalOptionsBoostByDataTypeText InstanceListResponseRetrievalOptionsBoostByDataType = "text"

const InstanceListResponseRetrievalOptionsBoostByDataTypeBoolean InstanceListResponseRetrievalOptionsBoostByDataType = "boolean"

Direction InstanceListResponseRetrievalOptionsBoostByDirectionOptional

One of the following:

const InstanceListResponseRetrievalOptionsBoostByDirectionAsc InstanceListResponseRetrievalOptionsBoostByDirection = "asc"

const InstanceListResponseRetrievalOptionsBoostByDirectionDesc InstanceListResponseRetrievalOptionsBoostByDirection = "desc"

const InstanceListResponseRetrievalOptionsBoostByDirectionExists InstanceListResponseRetrievalOptionsBoostByDirection = "exists"

const InstanceListResponseRetrievalOptionsBoostByDirectionNotExists InstanceListResponseRetrievalOptionsBoostByDirection = "not_exists"

KeywordMatchMode InstanceListResponseRetrievalOptionsKeywordMatchModeOptional

One of the following:

const InstanceListResponseRetrievalOptionsKeywordMatchModeAnd InstanceListResponseRetrievalOptionsKeywordMatchMode = "and"

const InstanceListResponseRetrievalOptionsKeywordMatchModeOr InstanceListResponseRetrievalOptionsKeywordMatchMode = "or"

RewriteModel string

RewriteQuery bool

ScoreThreshold float64

Source string

SourceParams InstanceListResponseSourceParams

ExcludeItems []stringOptional

IncludeItems []stringOptional

Prefix stringOptional

R2Jurisdiction stringOptional

WebCrawler InstanceListResponseSourceParamsWebCrawlerOptional

DiscoverOptions InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsOptional

Depth float64Optional

maximum100000

minimum1

IncludeExternalLinks boolOptional

IncludeSubdomains boolOptional

Limit float64Optional

Maximum number of pages to crawl. New values are capped at 100000; instances configured before that cap may report a higher stored value, which the crawler clamps at run time.

maximum100000

minimum1

MaxAge float64Optional

maximum604800

minimum0

Source InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceOptional

One of the following:

const InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceAll InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSource = "all"

const InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceSitemaps InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSource = "sitemaps"

const InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSourceLinks InstanceListResponseSourceParamsWebCrawlerDiscoverOptionsSource = "links"

ParseOptions InstanceListResponseSourceParamsWebCrawlerParseOptionsOptional

ContentSelector []InstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelectorOptional

Path string

maxLength200

minLength1

Selector string

maxLength200

minLength1

IncludeHeaders map[string, string]Optional

IncludeImages boolOptional

SpecificSitemaps []stringOptional

UseBrowserRendering boolOptional

ParseType InstanceListResponseSourceParamsWebCrawlerParseTypeOptional

One of the following:

const InstanceListResponseSourceParamsWebCrawlerParseTypeSitemap InstanceListResponseSourceParamsWebCrawlerParseType = "sitemap"

const InstanceListResponseSourceParamsWebCrawlerParseTypeDiscover InstanceListResponseSourceParamsWebCrawlerParseType = "discover"

Status string

Summarization bool

SummarizationModel string

SyncInterval InstanceListResponseSyncInterval

One of the following:

const InstanceListResponseSyncInterval900 InstanceListResponseSyncInterval = 900

const InstanceListResponseSyncInterval1800 InstanceListResponseSyncInterval = 1800

const InstanceListResponseSyncInterval3600 InstanceListResponseSyncInterval = 3600

const InstanceListResponseSyncInterval7200 InstanceListResponseSyncInterval = 7200

const InstanceListResponseSyncInterval14400 InstanceListResponseSyncInterval = 14400

const InstanceListResponseSyncInterval21600 InstanceListResponseSyncInterval = 21600

const InstanceListResponseSyncInterval43200 InstanceListResponseSyncInterval = 43200

const InstanceListResponseSyncInterval86400 InstanceListResponseSyncInterval = 86400

SystemPromptAISearch string

SystemPromptIndexSummarization string

SystemPromptRewriteQuery string

TokenID string

Type InstanceListResponseType

One of the following:

const InstanceListResponseTypeR2 InstanceListResponseType = "r2"

const InstanceListResponseTypeWebCrawler InstanceListResponseType = "web-crawler"

List AI Search instances.

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_search"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.AISearch.Instances.List(context.TODO(), ai_search.InstanceListParams{
    AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "result": [
    {
      "id": "id",
      "ai_gateway_id": "ai_gateway_id",
      "ai_search_model": "ai_search_model",
      "cache": true,
      "cache_threshold": "super_strict_match",
      "cache_ttl": 600,
      "chunk": true,
      "chunk_overlap": 0,
      "chunk_size": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "custom_metadata": [
        {
          "data_type": "text",
          "field_name": "field_name"
        }
      ],
      "embedding_model": "embedding_model",
      "enable": true,
      "engine_version": 0,
      "fusion_method": "max",
      "hybrid_search_enabled": true,
      "index_method": {
        "keyword": true,
        "vector": true
      },
      "indexing_options": {
        "keyword_tokenizer": "porter"
      },
      "last_activity": "2019-12-27T18:11:19.117Z",
      "max_num_results": 0,
      "metadata": {
        "created_from_aisearch_wizard": true,
        "worker_domain": "worker_domain"
      },
      "modified_at": "2019-12-27T18:11:19.117Z",
      "modified_by": "modified_by",
      "namespace": "namespace",
      "paused": true,
      "public_endpoint_id": "public_endpoint_id",
      "public_endpoint_params": {
        "authorized_hosts": [
          "string"
        ],
        "chat_completions_endpoint": {
          "disabled": true
        },
        "custom_domains": [
          "x"
        ],
        "default_domain_enabled": true,
        "enabled": true,
        "mcp": {
          "description": "description",
          "disabled": true
        },
        "rate_limit": {
          "period_ms": 60000,
          "requests": 1,
          "technique": "fixed"
        },
        "search_endpoint": {
          "disabled": true
        }
      },
      "reranking": true,
      "reranking_model": "reranking_model",
      "retrieval_options": {
        "boost_by": [
          {
            "field": "x",
            "dataType": "number",
            "direction": "asc"
          }
        ],
        "keyword_match_mode": "and"
      },
      "rewrite_model": "rewrite_model",
      "rewrite_query": true,
      "score_threshold": 0,
      "source": "source",
      "source_params": {
        "exclude_items": [
          "string"
        ],
        "include_items": [
          "string"
        ],
        "prefix": "prefix",
        "r2_jurisdiction": "r2_jurisdiction",
        "web_crawler": {
          "discover_options": {
            "depth": 1,
            "include_external_links": true,
            "include_subdomains": true,
            "limit": 1,
            "max_age": 0,
            "source": "all"
          },
          "parse_options": {
            "content_selector": [
              {
                "path": "x",
                "selector": "x"
              }
            ],
            "include_headers": {
              "foo": "string"
            },
            "include_images": true,
            "specific_sitemaps": [
              "https://example.com"
            ],
            "use_browser_rendering": true
          },
          "parse_type": "sitemap"
        }
      },
      "status": "status",
      "summarization": true,
      "summarization_model": "summarization_model",
      "sync_interval": 900,
      "system_prompt_ai_search": "system_prompt_ai_search",
      "system_prompt_index_summarization": "system_prompt_index_summarization",
      "system_prompt_rewrite_query": "system_prompt_rewrite_query",
      "token_id": "token_id",
      "type": "r2"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}

Returns Examples

{
  "result": [
    {
      "id": "id",
      "ai_gateway_id": "ai_gateway_id",
      "ai_search_model": "ai_search_model",
      "cache": true,
      "cache_threshold": "super_strict_match",
      "cache_ttl": 600,
      "chunk": true,
      "chunk_overlap": 0,
      "chunk_size": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "custom_metadata": [
        {
          "data_type": "text",
          "field_name": "field_name"
        }
      ],
      "embedding_model": "embedding_model",
      "enable": true,
      "engine_version": 0,
      "fusion_method": "max",
      "hybrid_search_enabled": true,
      "index_method": {
        "keyword": true,
        "vector": true
      },
      "indexing_options": {
        "keyword_tokenizer": "porter"
      },
      "last_activity": "2019-12-27T18:11:19.117Z",
      "max_num_results": 0,
      "metadata": {
        "created_from_aisearch_wizard": true,
        "worker_domain": "worker_domain"
      },
      "modified_at": "2019-12-27T18:11:19.117Z",
      "modified_by": "modified_by",
      "namespace": "namespace",
      "paused": true,
      "public_endpoint_id": "public_endpoint_id",
      "public_endpoint_params": {
        "authorized_hosts": [
          "string"
        ],
        "chat_completions_endpoint": {
          "disabled": true
        },
        "custom_domains": [
          "x"
        ],
        "default_domain_enabled": true,
        "enabled": true,
        "mcp": {
          "description": "description",
          "disabled": true
        },
        "rate_limit": {
          "period_ms": 60000,
          "requests": 1,
          "technique": "fixed"
        },
        "search_endpoint": {
          "disabled": true
        }
      },
      "reranking": true,
      "reranking_model": "reranking_model",
      "retrieval_options": {
        "boost_by": [
          {
            "field": "x",
            "dataType": "number",
            "direction": "asc"
          }
        ],
        "keyword_match_mode": "and"
      },
      "rewrite_model": "rewrite_model",
      "rewrite_query": true,
      "score_threshold": 0,
      "source": "source",
      "source_params": {
        "exclude_items": [
          "string"
        ],
        "include_items": [
          "string"
        ],
        "prefix": "prefix",
        "r2_jurisdiction": "r2_jurisdiction",
        "web_crawler": {
          "discover_options": {
            "depth": 1,
            "include_external_links": true,
            "include_subdomains": true,
            "limit": 1,
            "max_age": 0,
            "source": "all"
          },
          "parse_options": {
            "content_selector": [
              {
                "path": "x",
                "selector": "x"
              }
            ],
            "include_headers": {
              "foo": "string"
            },
            "include_images": true,
            "specific_sitemaps": [
              "https://example.com"
            ],
            "use_browser_rendering": true
          },
          "parse_type": "sitemap"
        }
      },
      "status": "status",
      "summarization": true,
      "summarization_model": "summarization_model",
      "sync_interval": 900,
      "system_prompt_ai_search": "system_prompt_ai_search",
      "system_prompt_index_summarization": "system_prompt_index_summarization",
      "system_prompt_rewrite_query": "system_prompt_rewrite_query",
      "token_id": "token_id",
      "type": "r2"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  },
  "success": true
}