klink-developers-logo

Vector Store

Detail

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

Returns a vector store with its indexing progress. After adding documents, poll this until documents.inProgress is 0. Documents that are still being indexed are not searchable yet.

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

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.

    • statusstring | nullrequired

      in_progress while documents are being indexed, completed when all are searchable. Null if the store's status could not be read.

      Allowed values:"in_progress", "completed", "expired", null

    • documentsobject | nullrequired

      Indexing progress per document state.

      Child attributes
      • inProgressintegerrequired

        Still being indexed. Poll until this is 0.

      • completedintegerrequired

        Indexed and searchable.

      • failedintegerrequired

        Could not be indexed (e.g. an empty or unreadable file). Remove and re-add them.

      • cancelledintegerrequired
      • totalintegerrequired
    • usageBytesinteger | nullrequired

      Storage used by the indexed documents.

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