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
Vellum AI

Vellum AI subpackage_documents API

The subpackage_documents API from Vellum AI — 3 operation(s) for subpackage_documents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vellum AI subpackage_documents API is one of 16 APIs that Vellum AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 3 base URLs: https://predict.vellum.ai, https://api.vellum.ai, https://documents.vellum.ai.

5 operations 3 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.vellum.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vellum AI subpackage_documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (default).

Paths & Operations 5

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

subpackage_documents 5
POST
/v1/upload-document
Upload
upload 2 params body → 201400404500
GET
/v1/documents/{id}
Retrieve
retrieve 3 params → 200
PATCH
/v1/documents/{id}
Partial Update
partial-update 3 params body → 200
DELETE
/v1/documents/{id}
Destroy
destroy 3 params → 204
GET
/v1/documents
List
list 7 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SlimDocument (10 properties), DocumentRead (10 properties), DocumentDocumentToDocumentIndex (6 properties), SlimDocumentDocumentToDocumentIndex (5 properties). Each schema is shown below with its type and property counts.

PaginatedSlimDocumentList
object
4 properties
DocumentStatus
string
ACTIVE - Active
SlimDocument
object
10 properties 5 required
UploadDocumentResponse
object
1 property 1 required
DocumentProcessingState
string
QUEUED - Queued PROCESSING - Processing PROCESSED - Processed FAILED - Failed UNKNOWN - Unknown
DocumentRead
object
10 properties 6 required
ProcessingFailureReasonEnum
string
EXCEEDEDCHARACTERLIMIT - Exceeded Character Limit INVALIDFILE - Invalid File INVALIDCREDENTIALS - Invalid Credentials
documents_destroy_Response_204
object
Empty response body
SlimDocumentDocumentToDocumentIndex
object
A slim representation of the link between a Document and a Document Index it's a member of.
5 properties 4 required
DocumentDocumentToDocumentIndex
object
A detailed representation of the link between a Document and a Document Index it's a member of.
6 properties 5 required
IndexingStateEnum
string
AWAITINGPROCESSING - Awaiting Processing QUEUED - Queued INDEXING - Indexing INDEXED - Indexed FAILED - Failed
UploadDocumentErrorResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vellum-subpackage-documents-api-openapi.yml Raw ↑

Other APIs Vellum AI publishes across the network.

Vellum LLM Platform API
AE Profile APIs.io
Vellum AI Default API
AE Profile APIs.io
Vellum AI subpackage_deployments API
AE Profile APIs.io
Vellum AI subpackage_documentIndexes API
AE Profile APIs.io
Vellum AI subpackage_events API
AE Profile APIs.io
Vellum AI subpackage_folderEntities API
AE Profile APIs.io
Vellum AI subpackage_sandboxes API
AE Profile APIs.io
Vellum AI subpackage_testSuiteRuns API
AE Profile APIs.io
Vellum AI subpackage_testSuites API
AE Profile APIs.io
Vellum AI subpackage_uploadedFiles API
AE Profile APIs.io
Vellum AI subpackage_workflowDeployments API
AE Profile APIs.io
Vellum AI subpackage_workflowExecutions API
AE Profile APIs.io
← Back to V APIs
API Details
ID
vellum:vellum-subpackage-documents-api
Base URL
https://api.vellum.ai
Docs
https://docs.vellum.ai
Provider
Vellum AI
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=vellum-subpackage-documents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vellum-subpackage-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 Vellum AI subpackage_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.