Vector Store

Create

POST/api/v1/vector-stores

Creates an empty vector store. Add documents with Add Document, then attach the store to an AI agent by putting its id in vectorStoreIds on an agentNode (AI Agent → Update Flow), and publish the agent.

Request

Authorization

Bearer Token

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

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

Body Paramsapplication/json
  • namestringrequired

    1-200 characters.

  • descriptionstringoptional

    Up to 1000 characters. For your own reference; the AI does not read it.

Responses

201

Created

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    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