Antimatter

POST/v1/vector_stores/{id}API key

Parameters

Path and query parameters
Field	Type	What it is
id (path)required	string	The vector store id, vs_ and 24 hex digits.

Request body

application/json, optional

Request body fields
Field	Type	What it is
name	string or null
metadata	object or null	At most 16 pairs of strings.
expires_after	object or null
expires_after.anchorrequired	"last_active_at"
expires_after.daysrequired	integer	From 1 to 365.

Example

{
  "name": "string",
  "metadata": {},
  "expires_after": {
    "anchor": "last_active_at",
    "days": 1
  }
}

Answer 200

The store.

Fields of the 200 answer
Field	Type	What it is
id	string
object	"vector_store"
created_at	integer
name	string
description	string or null
usage_bytes	integer	Every chunk's text and vector, summed over the store's files.
file_counts	object
file_counts.in_progress	integer
file_counts.completed	integer
file_counts.failed	integer
file_counts.cancelled	integer
file_counts.total	integer
status	string	One of "expired", "in_progress", "completed".
expires_after	object or null
expires_after.anchorrequired	"last_active_at"
expires_after.daysrequired	integer	From 1 to 365.
expires_at	integer or null
last_active_at	integer or null
metadata	object
embedding_model	string	Antimatter's own: the embedding model the store's chunks are embedded with.
embedding_dimensions	integer or null	Antimatter's own: the vectors' length, null until the first embedding names it.

Errors

400OpenAI shaped error.
401OpenAI shaped error.
402OpenAI shaped error.
403OpenAI shaped error.
404OpenAI shaped error.
429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Try it

The same call with curl

curl -X POST https://useantimatter.com/v1/vector_stores/{id} \
  -H "Authorization: Bearer $ANTIMATTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","metadata":{},"expires_after":{"anchor":"last_active_at","days":1}}'