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

Lists indexed items in an AI Search instance.

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

name string

id string

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64

minLength1

params NamespaceInstanceItemListParams

AccountID param.Field[string]

Path param

ItemID param.Field[string]Optional

Query param: Filter items by their unique ID. Returns at most one item.

maxLength64

MetadataFilter param.Field[string]Optional

Query param: JSON-encoded metadata filter using Vectorize filter syntax. Examples: {“folder”:“reports/”}, {“timestamp”:{“$gte”:1700000000000}}, {“folder”:{“$in”:[“docs/”,“reports/”]}}

maxLength2048

Page param.Field[int64]Optional

Query param

minimum1

PerPage param.Field[int64]Optional

Query param

maximum50

minimum0

Search param.Field[string]Optional

Query param

maxLength256

SortBy param.Field[NamespaceInstanceItemListParamsSortBy]Optional

Query param: Sort order for items. “status” (default) sorts by status priority then last_seen_at. “modified_at” sorts by file modification time (most recent first), falling back to created_at.

const NamespaceInstanceItemListParamsSortByStatus NamespaceInstanceItemListParamsSortBy = "status"

const NamespaceInstanceItemListParamsSortByModifiedAt NamespaceInstanceItemListParamsSortBy = "modified_at"

Source param.Field[string]Optional

Query param: Filter items by source_id. Use “builtin” for uploaded files, or a source identifier like “web-crawler:https://example.com”.

maxLength512

Status param.Field[NamespaceInstanceItemListParamsStatus]Optional

Query param

const NamespaceInstanceItemListParamsStatusQueued NamespaceInstanceItemListParamsStatus = "queued"

const NamespaceInstanceItemListParamsStatusRunning NamespaceInstanceItemListParamsStatus = "running"

const NamespaceInstanceItemListParamsStatusCompleted NamespaceInstanceItemListParamsStatus = "completed"

const NamespaceInstanceItemListParamsStatusError NamespaceInstanceItemListParamsStatus = "error"

const NamespaceInstanceItemListParamsStatusSkipped NamespaceInstanceItemListParamsStatus = "skipped"

const NamespaceInstanceItemListParamsStatusOutdated NamespaceInstanceItemListParamsStatus = "outdated"

ReturnsExpand Collapse

type NamespaceInstanceItemListResponse struct{…}

ID string

Checksum string

ChunksCount int64

CreatedAt Time

formatdate-time

FileSize float64

Key string

LastSeenAt Time

formatdate-time

Namespace string

NextAction NamespaceInstanceItemListResponseNextAction

One of the following:

const NamespaceInstanceItemListResponseNextActionIndex NamespaceInstanceItemListResponseNextAction = "INDEX"

const NamespaceInstanceItemListResponseNextActionDelete NamespaceInstanceItemListResponseNextAction = "DELETE"

SourceID string

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

Status NamespaceInstanceItemListResponseStatus

One of the following:

const NamespaceInstanceItemListResponseStatusQueued NamespaceInstanceItemListResponseStatus = "queued"

const NamespaceInstanceItemListResponseStatusRunning NamespaceInstanceItemListResponseStatus = "running"

const NamespaceInstanceItemListResponseStatusCompleted NamespaceInstanceItemListResponseStatus = "completed"

const NamespaceInstanceItemListResponseStatusError NamespaceInstanceItemListResponseStatus = "error"

const NamespaceInstanceItemListResponseStatusSkipped NamespaceInstanceItemListResponseStatus = "skipped"

const NamespaceInstanceItemListResponseStatusOutdated NamespaceInstanceItemListResponseStatus = "outdated"

Error stringOptional

Items List.

package main

import (
  "context"
  "fmt"

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

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

{
  "result": [
    {
      "id": "id",
      "checksum": "checksum",
      "chunks_count": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_size": 0,
      "key": "key",
      "last_seen_at": "2019-12-27T18:11:19.117Z",
      "namespace": "namespace",
      "next_action": "INDEX",
      "source_id": "source_id",
      "status": "queued",
      "error": "error"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "total_count": 0,
    "per_page": 5
  },
  "success": true
}

Returns Examples

{
  "result": [
    {
      "id": "id",
      "checksum": "checksum",
      "chunks_count": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_size": 0,
      "key": "key",
      "last_seen_at": "2019-12-27T18:11:19.117Z",
      "namespace": "namespace",
      "next_action": "INDEX",
      "source_id": "source_id",
      "status": "queued",
      "error": "error"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "total_count": 0,
    "per_page": 5
  },
  "success": true
}