Indexes

Create Index

Changed on

Create a searchable index over a source directory.

post/api/v1/indexes

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

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

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 00f6a6ae33caRevision changes
    • info

      added the new optional request property