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_documentIndexes API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include subpackage_documentIndexes. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 3 paths, and defines 79 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.

8 operations 3 paths 79 schemas 2 DELETE2 GET1 PATCH2 POST1 PUT

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_documentIndexes API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (default).

Paths & Operations 8

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

subpackage_documentIndexes 8
POST
/v1/document-indexes/{id}/documents/{document_id}
Add Document
add-document 4 params → 204
DELETE
/v1/document-indexes/{id}/documents/{document_id}
Remove Document
remove-document 4 params → 204
POST
/v1/document-indexes
Create
create 2 params body → 201
GET
/v1/document-indexes
List
list 7 params → 200
GET
/v1/document-indexes/{id}
Retrieve
retrieve 4 params → 200
PATCH
/v1/document-indexes/{id}
Partial Update
partial-update 3 params body → 200
PUT
/v1/document-indexes/{id}
Update
update 3 params body → 200
DELETE
/v1/document-indexes/{id}
Destroy
destroy 3 params → 204

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are DocumentIndexRead (6 properties), DocumentIndexCreateRequest (5 properties), PaginatedDocumentIndexReadList (4 properties), InstructorVectorizerConfigRequest (3 properties). Each schema is shown below with its type and property counts.

text-embedding-3-smallEnum
string
DocumentIndexChunking
EntityStatus
string
ACTIVE - Active ARCHIVED - Archived PENDINGDELETION - Pending Deletion
DelimiterChunkerConfigRequest
object
2 properties
HkunlpInstructorXlVectorizer
object
Vectorizer for hkunlp/instructor-xl.
2 properties 2 required
BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request
object
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.
2 properties 1 required
IndexingConfigVectorizer
sentence-transformers-multi-qa-mpnet-base-cos-v1Enum
string
SentenceChunkerConfig
object
Configuration for sentence chunking
2 properties
GoogleVertexAIVectorizerTextMultilingualEmbedding002Request
object
2 properties 2 required
AddOpenaiApiKeyEnum
boolean
True - True
sentence-chunkerEnum
string
TokenOverlappingWindowChunkerConfig
object
Configuration for token overlapping window chunking
2 properties
SentenceChunking
object
Sentence chunking
2 properties 1 required
text-multilingual-embedding-002Enum
string
OpenAIVectorizerTextEmbedding3Large
object
OpenAI vectorizer for text-embedding-3-large.
2 properties 2 required
DelimiterChunkingRequest
object
2 properties 1 required
PatchedDocumentIndexUpdateRequest
object
2 properties
PaginatedDocumentIndexReadList
object
4 properties
OpenAIVectorizerConfig
object
Configuration for using an OpenAI vectorizer.
1 property
GoogleVertexAIVectorizerGeminiEmbedding001Request
object
2 properties 2 required
PrivateVectorizerRequest
object
Serializer for private vectorizer.
1 property 1 required
gemini-embedding-001Enum
string
DocumentIndexIndexingConfig
object
2 properties 1 required
hkunlp-instructor-xlEnum
string
GoogleVertexAIVectorizerGeminiEmbedding001
object
2 properties 2 required
DocumentIndexRead
object
6 properties 5 required
ReductoChunkerConfig
object
Configuration for Reducto chunking
1 property
SentenceChunkerConfigRequest
object
Configuration for sentence chunking
2 properties
GoogleVertexAIVectorizerConfigRequest
object
2 properties 2 required
BasicVectorizerIntfloatMultilingualE5Large
object
Basic vectorizer for intfloat/multilingual-e5-large.
2 properties 1 required
TokenOverlappingWindowChunkerConfigRequest
object
Configuration for token overlapping window chunking
2 properties
BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request
object
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.
2 properties 1 required
text-embedding-ada-002Enum
string
OpenAIVectorizerConfigRequest
object
Configuration for using an OpenAI vectorizer.
1 property
OpenAIVectorizerTextEmbedding3SmallRequest
object
OpenAI vectorizer for text-embedding-3-small.
2 properties 2 required
reducto-chunkerEnum
string
BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1
object
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.
2 properties 1 required
TokenOverlappingWindowChunking
object
Token overlapping window chunking
2 properties 1 required
DelimiterChunkerConfig
object
2 properties
OpenAIVectorizerTextEmbedding3LargeRequest
object
OpenAI vectorizer for text-embedding-3-large.
2 properties 2 required
GoogleVertexAIVectorizerTextEmbedding004Request
object
2 properties 2 required
FastEmbedVectorizerBAAIBgeSmallEnV15Request
object
FastEmbed vectorizer for BAAI/bge-small-en-v1.5.
1 property 1 required
ReductoChunkingRequest
object
Reducto chunking
2 properties 1 required
text-embedding-004Enum
string
ReductoChunking
object
Reducto chunking
2 properties 1 required
OpenAIVectorizerTextEmbeddingAda002Request
object
OpenAI vectorizer for text-embedding-ada-002.
2 properties 2 required
DocumentIndexUpdateRequest
object
2 properties 1 required
ReductoChunkerConfigRequest
object
Configuration for Reducto chunking
1 property
V1DocumentIndexesGetParametersStatus
string
GoogleVertexAIVectorizerTextEmbedding004
object
2 properties 2 required
DocumentIndexIndexingConfigRequest
object
2 properties 1 required
InstructorVectorizerConfigRequest
object
Configuration for using an Instructor vectorizer.
3 properties 3 required
DocumentIndexChunkingRequest
text-embedding-3-largeEnum
string
DelimiterChunking
object
2 properties 1 required
BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1
object
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.
2 properties 1 required
SentenceChunkingRequest
object
Sentence chunking
2 properties 1 required
BasicVectorizerIntfloatMultilingualE5LargeRequest
object
Basic vectorizer for intfloat/multilingual-e5-large.
2 properties 1 required
GoogleVertexAIVectorizerTextMultilingualEmbedding002
object
2 properties 2 required
FastEmbedVectorizerBAAIBgeSmallEnV15
object
FastEmbed vectorizer for BAAI/bge-small-en-v1.5.
1 property 1 required
DocumentIndexCreateRequest
object
5 properties 3 required
private-vectorizerEnum
string
IndexingConfigVectorizerRequest
InstructorVectorizerConfig
object
Configuration for using an Instructor vectorizer.
3 properties 3 required
delimiter-chunkerEnum
string
GoogleVertexAIVectorizerConfig
object
2 properties 2 required
HkunlpInstructorXlVectorizerRequest
object
Vectorizer for hkunlp/instructor-xl.
2 properties 2 required
document-indexes_remove_document_Response_204
object
Empty response body
sentence-transformers-multi-qa-mpnet-base-dot-v1Enum
string
token-overlapping-window-chunkerEnum
string
document-indexes_destroy_Response_204
object
Empty response body
baai-bge-small-en-v1.5Enum
string
PrivateVectorizer
object
Serializer for private vectorizer.
1 property 1 required
OpenAIVectorizerTextEmbedding3Small
object
OpenAI vectorizer for text-embedding-3-small.
2 properties 2 required
OpenAIVectorizerTextEmbeddingAda002
object
OpenAI vectorizer for text-embedding-ada-002.
2 properties 2 required
TokenOverlappingWindowChunkingRequest
object
Token overlapping window chunking
2 properties 1 required
document-indexes_add_document_Response_204
object
Empty response body
intfloat-multilingual-e5-largeEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vellum-subpackage-documentindexes-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_documents 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
#subpackage_documentIndexes
← Back to V APIs
API Details
ID
vellum:vellum-subpackage-documentindexes-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-documentindexes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vellum-subpackage-documentindexes-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_documentIndexes 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.