How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vectara Documents API

Upload, index, retrieve, update, and delete documents in a corpus.

Vectara Documents API is one of 9 APIs that Vectara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 5 JSON Schemas.

This API exposes 8 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against 2 base URLs: https://api.vectara.io, https://auth.vectara.io.

8 operations 4 paths 3 schemas 2 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://api.vectara.io/v2
Authentication
API Key, OAuth 2.0
License
Proprietary
Resource Areas
1

Authentication & Security 2

Vectara Documents API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. By default, every request must be authenticated.

  • ApiKeyAuth — Vectara API key passed in the x-api-key header.
  • OAuth2 — OAuth 2.0 client credentials flow.

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 8

Upload, index, retrieve, update, and delete documents in a corpus.

POST
/v2/corpora/{corpus_key}/upload_file
Upload A File
uploadFile 1 param body → 201
GET
/v2/corpora/{corpus_key}/documents
List Corpus Documents
listDocuments 4 params → 200
POST
/v2/corpora/{corpus_key}/documents
Add A Structured (Core) Document
addDocument 1 param body → 201
DELETE
/v2/corpora/{corpus_key}/documents
Bulk Delete Documents
bulkDeleteDocuments 2 params → 204
GET
/v2/corpora/{corpus_key}/documents/{document_id}
Retrieve A Document
getDocument 2 params → 200
PATCH
/v2/corpora/{corpus_key}/documents/{document_id}
Update Document Metadata
updateDocument 2 params body → 200
DELETE
/v2/corpora/{corpus_key}/documents/{document_id}
Delete A Document
deleteDocument 2 params → 204
POST
/v2/corpora/{corpus_key}/documents/{document_id}/summarize
Summarize A Document
summarizeDocument 2 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Document (4 properties), ListDocumentsResponse (2 properties), PageMetadata (2 properties). Each schema is shown below with its type and property counts.

Document
object
4 properties
PageMetadata
object
2 properties
ListDocumentsResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vectara-documents-api-openapi.yml Raw ↑

Other APIs Vectara publishes across the network.

Vectara Chat API
Vectara OAuth 2.0 Token API
Vectara Agents API
Vectara Authentication API
Vectara Corpora API
Vectara Pipelines API
Vectara Query API
Vectara Tools API
Where this information came from

This is an independent, third-party profile of Vectara Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.