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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vespa

Vespa Documents API

Single-document GET, POST, PUT, DELETE operations

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: http://{vespa_endpoint}/document/v1, http://localhost:8080, https://{endpoint}.vespa-cloud.com.

11 operations 4 paths 8 schemas 3 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
http://{vespa_endpoint}/document/v1
http://localhost:8080
https://{endpoint}.vespa-cloud.com
Authentication
Mutual TLS
Resource Areas
1

Authentication & Security 1

Vespa Documents API declares 1 security scheme for authenticating requests. It requires mutual TLS (mtls).

  • mtls — Client certificate authentication (Vespa enforces mTLS when configured)

Paths & Operations 11

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

Documents 11

Single-document GET, POST, PUT, DELETE operations

GET
/{namespace}/{doctype}/docid/{docid}
Get a single document
getDocument 4 params → 200404
POST
/{namespace}/{doctype}/docid/{docid}
Put (create or overwrite) a document
putDocument 5 params body → 200
PUT
/{namespace}/{doctype}/docid/{docid}
Update (partial update) a document
updateDocument 5 params body → 200
DELETE
/{namespace}/{doctype}/docid/{docid}
Delete a document
deleteDocument 4 params → 200
GET
/document/v1/
Visit Documents Across Cluster
visitAllDocuments 7 params → 200400429
GET
/document/v1/{namespace}/{documentType}/docid/{documentId}
Get Document By Id
getDocument 6 params → 200404
POST
/document/v1/{namespace}/{documentType}/docid/{documentId}
Put Document
putDocument 6 params body → 200400412413
PUT
/document/v1/{namespace}/{documentType}/docid/{documentId}
Update Document
updateDocument 7 params body → 200412
DELETE
/document/v1/{namespace}/{documentType}/docid/{documentId}
Remove Document
removeDocument 6 params → 200
GET
/document/v1/{namespace}/{documentType}/docid
Visit Documents Of A Type
visitDocumentsByType 9 params → 200
DELETE
/document/v1/{namespace}/{documentType}/docid
Delete Documents Matching Selection
deleteWhere 5 params → 200

Schemas 8

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

DocumentBody
object
1 property 1 required
DocumentWriteResponse
object
3 properties
VisitResponse
object
5 properties
DocumentUpdate
object
1 property
DocumentPut
object
1 property
DocumentUpdateBody
object
1 property 1 required
Document_2
object
3 properties
Document
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vespa-ai-documents-api-openapi.yml Raw ↑

Other APIs Vespa publishes across the network.

Vespa Deploy API
AE Profile APIs.io
Vespa Tenant and Application API
AE Profile APIs.io
Vespa Config API
AE Profile APIs.io
Vespa Cluster Controller API
AE Profile APIs.io
Vespa State API
AE Profile APIs.io
Vespa Metrics API
AE Profile APIs.io
Vespa Query API
AE Profile APIs.io
Vespa Visit API
AE Profile APIs.io
#Documents
← Back to V APIs
API Details
ID
vespa-ai:vespa-ai-documents-api
Server
http://{vespa_endpoint}/document/v1
Docs
https://docs.vespa.ai/en/reference/document-v1-api-reference.html
Provider
Vespa
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vespa-ai-documents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vespa-ai-documents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Vespa 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.