Docs

API reference

Vector stores

Hosted documents and search, on the OpenAI Vector Stores shape: attach uploaded files to a store, search it with filters, or let the Responses file_search tool do it. Available where it is switched on.

Base URL https://api.siliconnetwork.io

List Vector Stores

ParameterInTypeDescription
limitqueryinteger
orderquerystring
afterquerystring | null
beforequerystring | null
silicon - zsh
curl https://api.siliconnetwork.io/v1/vector_stores \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Create Vector Store

Create a store: `name`, `file_ids`, `metadata`, `expires_after`, `chunking_strategy` (for the files in `file_ids`), in OpenAI's shape.

silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/vector_stores \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Retrieve Vector Store

ParameterInTypeDescription
vector_store_id*pathstring
silicon - zsh
curl https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id} \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Modify Vector Store

Change `name`, `metadata` or `expires_after` (null removes the expiry).

ParameterInTypeDescription
vector_store_id*pathstring
silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id} \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Delete Vector Store

ParameterInTypeDescription
vector_store_id*pathstring
silicon - zsh
curl -X DELETE https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id} \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Search Vector Store

Search: `query` (a string or a list), `max_num_results` (1 to 50, default 10), `filters` on file attributes, `ranking_options` {ranker, score_threshold}. `rewrite_query` is accepted and ignored: the query is searched as sent.

ParameterInTypeDescription
vector_store_id*pathstring
silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id}/search \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

List Vector Store Files

ParameterInTypeDescription
vector_store_id*pathstring
limitqueryinteger
orderquerystring
afterquerystring | null
beforequerystring | null
filterquerystring | null
silicon - zsh
curl https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id}/files \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Create Vector Store File

Attach an uploaded file: `file_id`, optional `attributes` and `chunking_strategy`. Ingestion runs in the background; poll the file (or the store's file_counts) until its status leaves in_progress.

ParameterInTypeDescription
vector_store_id*pathstring
silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id}/files \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Retrieve Vector Store File

ParameterInTypeDescription
vector_store_id*pathstring
file_id*pathstring
silicon - zsh
curl https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id}/files/file-... \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Update Vector Store File

Replace the file's `attributes` (only when sent; null clears them).

ParameterInTypeDescription
vector_store_id*pathstring
file_id*pathstring
silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id}/files/file-... \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Delete Vector Store File

Remove the file from the store (its chunks go too). The uploaded file stays in the Files API until it is deleted there or expires.

ParameterInTypeDescription
vector_store_id*pathstring
file_id*pathstring
silicon - zsh
curl -X DELETE https://api.siliconnetwork.io/v1/vector_stores/{vector_store_id}/files/file-... \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Silicon Network›Docs›API›Vector stores46 items