klink-developers-logo

Vector Store

Listing

GET/api/v1/vector-stores

Lists the vector stores in your workspace. A vector store is a searchable set of documents an AI agent can answer from (File Search).

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params
  • pageintegeroptional

    Default 1.

    Default:1

    Example:1

  • pageSizeintegeroptional

    Default 10, max 100.

    Default:10

    Example:10

Responses

200

OK

  • pageintegerrequired
  • pageSizeintegerrequired
  • totalintegerrequired
  • lastPageintegerrequired
  • dataarray[object]required
    Child attributes
    • idstringrequired

      Vector store ID (vs_...). Use it in vectorStoreIds on an agentNode (AI Agent → Update Flow).

    • namestringrequired
    • descriptionstring | nullrequired
    • documentCountintegerrequired

      Documents attached to the store.

    • createdAtstring | nullrequired

      ISO 8601.

400

Invalid body or parameters, e.g. an empty name or a malformed ID.

  • messagestringrequired
401

API key missing, invalid, revoked or expired.

  • messagestringrequired
429

Rate limit reached. Retry after a short pause.

  • messagestringrequired
502

The AI agent service is temporarily unavailable. Retry shortly.

  • messagestringrequired