Indexes

Create Index

Create a searchable index over a source directory.

post/api/v1/indexes

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

source_directory_idstring required

ID of the source directory containing your documents.

namestring nullable

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

descriptionstring nullable

Optional description of the index.

sync_frequencystring

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

store_attachmentsstring[] nullable

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.

vector_target'DEFAULT' | 'DISABLED'

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'.

Example request

{
  "source_directory_id": "dir-abc123",
  "products": [
    {
      "product_config_id": "cfg-abc123",
      "product_type": "parse"
    }
  ],
  "sync_frequency": "manual",
  "store_attachments": [
    "screenshots"
  ],
  "vector_target": "DEFAULT"
}

Response

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required

Index name.

descriptionstring nullable

Index description.

project_idstring required

Project this index belongs to.

source_directory_idstring required

ID of the source directory.

sync_config_idstring required

ID of the sync configuration.

export_config_idstring required

ID of the export configuration.

last_synced_atstring date-time nullable

Last sync time.

last_exported_atstring date-time nullable

Last export time.

metadataIndexMetadata

Build state and diagnostic info about an index. Schema is open; only status of ready or failed is stable.

Changes

Changed in 6 of the 33 revisions of this API.38

Jun 9, 2026b17341164de92See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 28, 202600f6a6ae33ca1See the full diff
- ○
  added the new optional request property vector_target
  new-optional-request-property
May 27, 20261c29e1491a3823See the full diff
- ▲
  removed the enum value extract of the request property products/anyOf[subschema #1]/items/product_type
  request-property-enum-value-removed
- ▲
  removed the enum value parse of the request property products/anyOf[subschema #1]/items/product_type
  request-property-enum-value-removed
- ○
  added the new optional request property name
  new-optional-request-property
- ○
  added the new optional request property store_attachments
  new-optional-request-property
- ○
  added the new optional request property sync_frequency
  new-optional-request-property
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 23, 202634da5826db1c1See the full diff
- ○
  endpoint added
  endpoint-added
May 21, 2026fb63fb8d662c1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 19, 202664b8ab5b0a0a1See the full diff
- ○
  endpoint added
  endpoint-added

Full history