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

Vellum AI Search API

The Search API from Vellum AI — 1 operation(s) for search.

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

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

This API exposes 1 operation across 1 path, and defines 75 schemas. It is described by OpenAPI 3.2.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.

1 operations 1 paths 75 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Search 1
POST
/v1/search
Search
search 2 params body → 200400404500

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are MetadataFilterConfigRequest (6 properties), MetadataFilterRuleRequest (6 properties), SearchResult (5 properties), ChatMessageRequest (5 properties). Each schema is shown below with its type and property counts.

DocumentChatMessageContentRequest
object
A document value that is used in a chat message.
2 properties 2 required
SearchResultMetaRequest
object
1 property
VideoVellumValueRequest
object
A base Vellum primitive value representing a video.
2 properties 2 required
ArrayChatMessageContentRequest
object
A list of chat message content items.
2 properties 2 required
StringChatMessageContentRequest
object
A string value that is used in a chat message.
2 properties 2 required
LogicalOperator
string
= - EQUALS != - DOESNOTEQUAL - GREATERTHAN = - GREATERTHANOREQUALTO contains - CONTAINS beginsWith - BEGINSWITH endsWith - ENDSWITH doesNotContain - DOESNOTCON…
SearchWeightsRequest
object
2 properties
VellumAudioRequest
object
2 properties 1 required
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
SearchResultRequest
object
5 properties 4 required
VellumErrorRequest
object
3 properties 2 required
PdfEnum
string
AudioChatMessageContentRequest
object
An audio value that is used in a chat message.
2 properties 2 required
ChatHistoryEnum
string
VellumValueLogicalConditionGroupRequest
object
A higher-order condition that combines one or more basic conditions or other higher-order conditions.
4 properties 4 required
SearchResultMeta
object
1 property
SearchRequestOptionsRequest
object
4 properties
ConditionCombinator
string
OR - OR AND - AND
SearchResultsVellumValueRequest
object
A value representing Search Results.
2 properties 2 required
SearchErrorResponse
object
1 property 1 required
SearchRequestBodyRequest
object
5 properties 1 required
ArrayEnum
string
ArrayChatMessageContentItemRequest
FunctionCallVellumValueRequest
object
A value representing a Function Call.
2 properties 2 required
LogicalConditionEnum
string
FunctionCallEnum
string
SearchResultMetaSource
DocumentVellumValueRequest
object
A base Vellum primitive value representing a document.
2 properties 2 required
VellumVideoRequest
object
2 properties 1 required
MetadataFilterRuleRequest
object
6 properties
ChatHistoryVellumValueRequest
object
A value representing Chat History.
2 properties 2 required
VellumValueLogicalConditionRequest
object
A basic condition comparing two Vellum values.
4 properties 4 required
VellumValueLogicalExpressionRequest
LogicalConditionGroupEnum
string
MetadataFiltersRequest
SearchResult
object
5 properties 4 required
PdfSearchResultMetaSource
object
The source of a search result from a PDF document.
3 properties 3 required
VideoEnum
string
NumberEnum
string
VellumValueRequest
SearchResultsEnum
string
ThinkingEnum
string
MetadataFilterRuleCombinator
string
and - AND or - OR
VellumDocumentRequest
object
2 properties 1 required
PdfSearchResultMetaSourceRequest
object
The source of a search result from a PDF document.
3 properties 3 required
FunctionCallChatMessageContentValueRequest
object
The final resolved function call value.
3 properties 2 required
StringVellumValueRequest
object
A value representing a string.
2 properties 2 required
ImageEnum
string
VellumImageRequest
object
2 properties 1 required
SearchResponse
object
1 property 1 required
JsonEnum
string
SearchFiltersRequest
object
2 properties
ChatMessageContentRequest
ImageVellumValueRequest
object
A base Vellum primitive value representing an image.
2 properties 2 required
AudioVellumValueRequest
object
A base Vellum primitive value representing audio.
2 properties 2 required
MetadataFilterConfigRequest
object
A deprecated pattern for filtering on metadata. Please use MetadataFilters instead.
6 properties
ThinkingVellumValueRequest
object
A value representing Thinking mode output.
2 properties 2 required
ChatMessageRequest
object
5 properties 1 required
FunctionCallRequest
object
The final resolved function call value.
3 properties 2 required
SearchResultMetaSourceRequest
ErrorVellumValueRequest
object
A value representing an Error.
2 properties 2 required
ArrayVellumValueRequest
object
A value representing an array of Vellum variable values.
2 properties 2 required
AudioEnum
string
ImageChatMessageContentRequest
object
An image value that is used in a chat message.
2 properties 2 required
SearchResultDocumentRequest
object
4 properties 1 required
StringEnum
string
NumberVellumValueRequest
object
A value representing a number.
2 properties 2 required
ErrorEnum
string
SearchResultMergingRequest
object
1 property
JsonVellumValueRequest
object
A value representing a JSON object.
2 properties 2 required
SearchResultDocument
object
4 properties 1 required
DocumentEnum
string
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
FunctionCallChatMessageContentRequest
object
A function call value that is used in a chat message.
2 properties 2 required
VideoChatMessageContentRequest
object
A video value that is used in a chat message.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vellum-search-api-openapi.yml Raw ↑

Other APIs Vellum AI publishes across the network.

Vellum LLM Platform API
Vellum AI Subpackage Deployments API
Vellum AI Subpackage Document Indexes API
Vellum AI Subpackage Documents API
Vellum AI Subpackage Events API
Vellum AI Subpackage Folder Entities API
Vellum AI Subpackage Sandboxes API
Vellum AI Subpackage Test Suite Runs API
Vellum AI Subpackage Test Suites API
Vellum AI Subpackage Uploaded Files API
Vellum AI Subpackage Workflow Deployments API
Vellum AI Subpackage Workflow Executions API
Where this information came from

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