API Reference

Beta

Indexes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Index

IndexGetResponse Beta.Indexes.Get(IndexGetParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/indexes/{index_id}

Get an index by ID.

ParametersExpand Collapse

IndexGetParams parameters

required string indexID

string? organizationID

string? projectID

ReturnsExpand Collapse

class IndexGetResponse:

A searchable index over a directory of documents.

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

Get Index

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

IndexGetParams parameters = new() { IndexID = "index_id" };

var index = await client.Beta.Indexes.Get(parameters);

Console.WriteLine(index);

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}