API Reference

Beta

Indexes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Index

IndexCreateResponse Beta.Indexes.Create(IndexCreateParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/indexes

Create a searchable index over a source directory.

ParametersExpand Collapse

IndexCreateParams parameters

required string sourceDirectoryID

Body param: ID of the source directory containing your documents.

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

string? description

Body param: Optional description of the index.

string? name

Body param: Optional display name for the index. If omitted, the index is named after the source directory.

IReadOnlyList<Product>? products

Body param: Product configurations for syncing. Omit to use a default parse configuration. Include an explicit entry per product type (e.g. parse, extract) to override the default.

required string ProductConfigID

ID of the product configuration.

required string ProductType

Product type. One of: parse, extract.

IReadOnlyList<string>? storeAttachments

Body param: Attachment kinds to store alongside parsed output. Each entry must be one of: screenshots, items. For example, [‘screenshots’] renders and stores per-page screenshots; [‘items’] stores structured items with bounding boxes. Omit or pass an empty list to skip attachments.

string syncFrequency

Body param: How often to re-run the sync. One of: manual, daily, on_source_change. Defaults to manual.

VectorTarget vectorTarget

Body param: Vector export destination for the index. ‘DEFAULT’ exports to the managed vector DB destination resolved from configuration. ‘DISABLED’ skips vector export — the export destination falls back to ‘Download’.

"DEFAULT"Default

"DISABLED"Disabled

ReturnsExpand Collapse

class IndexCreateResponse:

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

Create Index

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

IndexCreateParams parameters = new() { SourceDirectoryID = "dir-abc123" };

var index = await client.Beta.Indexes.Create(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"
}