API Reference

Beta

Indexes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Indexes

IndexListPageResponse Beta.Indexes.List(IndexListParams?parameters, CancellationTokencancellationToken = default)

GET/api/v1/indexes

List indexes for the current project.

ParametersExpand Collapse

IndexListParams parameters

string? organizationID

Long? pageSize

string? pageToken

string? projectID

string? sourceDirectoryID

ReturnsExpand Collapse

class IndexListPageResponse:

Paginated list of indexes.

required IReadOnlyList<IndexListResponse> Items

The list of items.

required string ID

Unique identifier

required string ExportConfigID

ID of the export configuration.

required string Name

Index name.

required string OutputDirectoryID

ID of the output directory holding the indexed files.

required string ProjectID

Project this index belongs to.

required string SourceDirectoryID

ID of the source directory.

required string SyncConfigID

ID of the sync configuration.

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

string? Description

Index description.

DateTimeOffset? LastExportedAt

Last export time.

formatdate-time

DateTimeOffset? LastSyncedAt

Last sync time.

formatdate-time

IReadOnlyDictionary<string, JsonElement> Metadata

Build state and diagnostic info.

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

string? NextPageToken

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Long? TotalSize

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Indexes

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

IndexListParams parameters = new();

var page = await client.Beta.Indexes.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

200 example

{
  "items": [
    {
      "id": "id",
      "export_config_id": "export_config_id",
      "name": "name",
      "output_directory_id": "output_directory_id",
      "project_id": "project_id",
      "source_directory_id": "source_directory_id",
      "sync_config_id": "sync_config_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "last_exported_at": "2019-12-27T18:11:19.117Z",
      "last_synced_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "export_config_id": "export_config_id",
      "name": "name",
      "output_directory_id": "output_directory_id",
      "project_id": "project_id",
      "source_directory_id": "source_directory_id",
      "sync_config_id": "sync_config_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "last_exported_at": "2019-12-27T18:11:19.117Z",
      "last_synced_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}