Create vector store

Create a new vector store.

Example

Request

curl -X POST https://api.upstage.ai/v2/vector_stores \
  -H "Authorization: Bearer $UPSTAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "product-docs",
    "metadata": {"team": "engineering"}
  }'

Response

{
  "id": "vs_abc123def456",
  "object": "vector_store",
  "created_at": 1711644800,
  "name": "product-docs",
  "usage_bytes": 0,
  "file_counts": {
    "in_progress": 0,
    "completed": 0,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  },
  "status": "completed",
  "last_active_at": 1711644800,
  "expires_after": null,
  "expires_at": null,
  "metadata": {"team": "engineering"}
}

Retrieve job

Poll a job by job_id for its status and result. Covers the include query parameter, the response object (status, output, usage), and an example request and response.

List vector stores

List your vector stores. Covers the pagination parameters (limit, order, after, before), the list object returned (data, first_id, last_id, has_more), and an example request and response.

Create vector store

Example

Request

Response

On this page

Create vector store

Example

Request

Response

On this page

Authorization

`Authorization`
Required
Bearer <token>

Request Body

`name`string

`description`string

`file_ids`array<string>

`chunking_strategy`object

`expires_after`object

`metadata`object

Response

On this page

Response

On this page

Body

AuthorizationRequiredBearer <token>

namestring

descriptionstring

file_idsarray<string>

chunking_strategyobject

Attributes

expires_afterobject

Attributes

metadataobject

`Authorization`
Required
Bearer <token>

`name`string

`description`string

`file_ids`array<string>

`chunking_strategy`object

`expires_after`object

`metadata`object