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

The subpackage_workflowSandboxes API from Vellum AI — 1 operation(s) for subpackage_workflowsandboxes.

Vellum AI subpackage_workflowSandboxes 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_workflowSandboxes. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 61 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.

1 operations 1 paths 61 schemas 1 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_workflowSandboxes 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.

subpackage_workflowSandboxes 1
POST
/v1/workflow-sandboxes/{id}/deploy
Deploy Workflow
deploy-workflow 3 params body → 200

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are WorkflowDeploymentRead (12 properties), VellumVariable (7 properties), ChatMessage (5 properties), DeploySandboxWorkflowRequest (5 properties). Each schema is shown below with its type and property counts.

VellumImage
object
2 properties 1 required
ErrorVellumValue
object
A value representing an Error.
2 properties 2 required
EntityStatus
string
ACTIVE - Active ARCHIVED - Archived PENDINGDELETION - Pending Deletion
PdfEnum
string
ChatMessageContent
ChatMessage
object
5 properties 1 required
StringEnum
string
DocumentVellumValue
object
A base Vellum primitive value representing a document.
2 properties 2 required
DeploySandboxWorkflowRequest
object
5 properties
NumberVellumValue
object
A value representing a number.
2 properties 2 required
StringVellumValue
object
A value representing a string.
2 properties 2 required
AudioChatMessageContent
object
An audio value that is used in a chat message.
2 properties 2 required
SearchResultsVellumValue
object
A value representing Search Results.
2 properties 2 required
WorkflowDeploymentDisplayData
object
Workflow Deployment display data
1 property
ChatHistoryVellumValue
object
A value representing Chat History.
2 properties 2 required
DocumentEnum
string
ArrayVellumValue
object
A value representing an array of Vellum variable values.
2 properties 2 required
ThinkingEnum
string
VellumVariableType
string
STRING - STRING NUMBER - NUMBER JSON - JSON CHATHISTORY - CHATHISTORY SEARCHRESULTS - SEARCHRESULTS ERROR - ERROR ARRAY - ARRAY FUNCTIONCALL - FUNCTIONCALL AUD…
FunctionCallVellumValue
object
A value representing a Function Call.
2 properties 2 required
ChatHistoryEnum
string
VellumVariable
object
7 properties 3 required
FunctionCallChatMessageContent
object
A function call value that is used in a chat message.
2 properties 2 required
ImageChatMessageContent
object
An image value that is used in a chat message.
2 properties 2 required
SearchResult
object
5 properties 4 required
VideoEnum
string
VellumDocument
object
2 properties 1 required
VideoChatMessageContent
object
A video value that is used in a chat message.
2 properties 2 required
ImageVellumValue
object
A base Vellum primitive value representing an image.
2 properties 2 required
VideoVellumValue
object
A base Vellum primitive value representing a video.
2 properties 2 required
JsonEnum
string
PdfSearchResultMetaSource
object
The source of a search result from a PDF document.
3 properties 3 required
ThinkingVellumValue
object
A value representing Thinking mode output.
2 properties 2 required
VellumAudio
object
2 properties 1 required
SearchResultMeta
object
1 property
SearchResultDocument
object
4 properties 1 required
SearchResultsEnum
string
FunctionCallEnum
string
SearchResultMetaSource
AudioVellumValue
object
A base Vellum primitive value representing audio.
2 properties 2 required
WorkflowDeploymentRead
object
A Workflow Deployment's full details.
12 properties 8 required
ArrayEnum
string
VellumValue
ArrayChatMessageContent
object
A list of chat message content items.
2 properties 2 required
AudioEnum
string
VellumVariableExtensions
object
A set of fields with additional properties for use in Vellum Variables.
3 properties
VellumErrorCodeEnum
string
INVALIDREQUEST - INVALIDREQUEST INVALIDINPUTS - INVALIDINPUTS PROVIDERERROR - PROVIDERERROR PROVIDERCREDENTIALSUNAVAILABLE - PROVIDERCREDENTIALSUNAVAILABLE INT…
ImageEnum
string
ArrayChatMessageContentItem
ChatMessageRole
string
SYSTEM - System ASSISTANT - Assistant USER - User FUNCTION - Function
FunctionCall
object
The final resolved function call value.
3 properties 2 required
JsonVellumValue
object
A value representing a JSON object.
2 properties 2 required
VellumVideo
object
2 properties 1 required
StringChatMessageContent
object
A string value that is used in a chat message.
2 properties 2 required
NumberEnum
string
VellumError
object
3 properties 2 required
ErrorEnum
string
WorkflowDisplayIcon
object
Icon to be used alongside a Workflow
2 properties
EnvironmentEnum
string
FunctionCallChatMessageContentValue
object
The final resolved function call value.
3 properties 2 required
DocumentChatMessageContent
object
A document value that is used in a chat message.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Vellum AI publishes across the network.

Vellum LLM Platform API
Vellum AI Default API
Vellum AI subpackage_deployments API
Vellum AI subpackage_documentIndexes API
Vellum AI subpackage_documents API
Vellum AI subpackage_events API
Vellum AI subpackage_folderEntities API
Vellum AI subpackage_sandboxes API
Vellum AI subpackage_testSuiteRuns API
Vellum AI subpackage_testSuites API
Vellum AI subpackage_uploadedFiles API
Vellum AI subpackage_workflowDeployments API
Where this information came from

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