klink-developers-logo

Vector Store

Update

PATCH/api/v1/vector-stores/{id}

Renames a vector store or changes its description. Send only the fields you want to change.

Request

Authorization

Bearer Token

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

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

Path Params
  • idstringrequired

    Vector store ID (vs_...).

    Example:vs_6ae7fb336d6c8191842d074ec05637f1

Body Paramsapplication/json
  • namestringoptional

    1-200 characters.

  • descriptionstringoptional

    Up to 1000 characters.

Responses

200

OK

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

No vector store with this ID in your workspace.

  • messagestringrequired
429

Rate limit reached. Retry after a short pause.

  • messagestringrequired
502

The AI agent service is temporarily unavailable. Retry shortly.

  • messagestringrequired