Add files to vector store

Add parsed files to a vector store for indexing and search.

This endpoint initiates an asynchronous process to add files to a vector store:

1. Creates a background job to track the operation
2. Starts a Temporal workflow to process the files
3. Files are parsed, chunked, and embedded into the vector store
4. Job status can be monitored via the jobs API

Authentication:

• Credentials can be provided either through project-level credentials or request-level credentials
• For SGP Knowledge Base, SGP credentials are required

Process:

• The operation runs asynchronously in the background
• Use the returned job entity to monitor progress
• Files must be previously parsed (have parse_result_ids)

Returns:

• Job entity with ID, status, and metadata for tracking the operation progress

Example Request:

{
    "parse_result_ids": ["parse_123", "parse_456"],
    "credentials": {
        "sgp": {
            "api_key": "your-api-key",
            "account_id": "your-account-id"
        }
    }
}

Example Response:

{
    "id": "job_123456789",
    "operation": "VECTOR_STORE",
    "status": "PENDING",
    "parameters": {
        "parse_result_ids": ["parse_123", "parse_456"]
    },
    "source_id": null,
    "project_id": "proj_987654321",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
}

POST /v1/projects/{project_id}/vector-stores/{vector_store_id}/files

Add files to vector store

cURL

curl --request POST \
  --url https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>' \
  --data '
{
  "parse_result_ids": [
    "<string>"
  ]
}
'

200

{
  "id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "job",
  "source_id": "<string>",
  "correlation_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "result": {},
  "progress": {
    "total": 123,
    "succeeded": 123,
    "failed": 123,
    "cancelled": 123,
    "pending": 123,
    "child_jobs": [
      {
        "source_document_id": "<string>",
        "job_id": "<string>",
        "parse_result_id": "<string>",
        "error": "<string>"
      }
    ]
  },
  "error": "<string>",
  "history": [
    {
      "step": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "status": "<string>",
      "details": {}
    }
  ]
}

Authorizations

x-api-key · string · header · required

API key for authentication

x-selected-account-id · string · header · required

Selected Account ID

Path Parameters

project_id · string · required

vector_store_id · string · required

Body

application/json

parse_result_ids · string[] · required

IDs of the parse results

Response

200

application/json

Files added to vector store successfully. Job entity returned for tracking progress.

Job response model representing an asynchronous operation.

id · string · required

ID of the entity

project_id · string · required

ID of the project

operation · enum<string> · required

Operation type (e.g., 'parse')

Available options: parse, batch_parse, extract, research, vector_store, chunk, summarization, create_index, update_index

status · enum<string> · required

Current job status

Available options: pending, running, succeeded, partially_succeeded, failed, cancelled

created_at · string<date-time> · required

When the job was created

object · string · default: job

Allowed value: "job"

source_id · string | null

Source document/file ID

correlation_id · string | null

Request correlation ID for tracing

started_at · string<date-time> | null

When the job started processing

completed_at · string<date-time> | null

When the job completed

result · Result · object

Job result payload when completed

progress · BatchParseProgress · object

Live progress payload (used by batch jobs)

Show child attributes

error · string | null

Error message if job failed

history · JobHistoryEvent · object[] | null

Timeline of job execution events

Show child attributes