Executes a deployed Prompt and returns the result.

Execute Prompt

Executes a deployed Prompt and streams back the results.

Execute Prompt as Stream

Used to submit feedback regarding the quality of previously generated completions.

Submit Prompt Execution Actuals

Retrieve Provider Payload

Deploy Prompt Sandbox

Upsert Prompt Sandbox Scenario

Deletes an existing scenario from a sandbox, keying off of the provided scenario id.

Delete Prompt Sandbox Scenario

Prompt Sandboxes

List Prompt Deployments

Used to retrieve a Prompt Deployment given its ID or name.

Retrieve Prompt Deployment

Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.

Retrieve Prompt Deployment Release Tag

Updates an existing Release Tag associated with the specified Deployment.

Update Prompt Deployment Release Tag

Prompt Deployments

Prompts

Executes a deployed Workflow and returns its outputs.

Execute Workflow

Executes a deployed Workflow and streams back its results.

Execute Workflow as Stream

Submit Workflow Execution Actuals

Deploy Workflow

Workflow Sandboxes

List Workflow Deployments

Used to retrieve a workflow deployment given its ID or name.

Retrieve Workflow Deployment

Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.

Retrieve Workflow Deployment Release Tag

Updates an existing Release Tag associated with the specified Workflow Deployment.

Update Workflow Deployment Release Tag

Workflow Deployments

Workflows

Perform a search against a document index.

Search

Adds a previously uploaded Document to the specified Document Index.

Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.

Add Document

Removes a Document from a Document Index without deleting the Document itself.

Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.

Remove Document

Index Using Instructor Model

Index Using a Sentence Transformers Model

Index Using OpenAI Model

Create Document Index

Used to retrieve a Document Index given its ID or name.

Either the Document Index's ID or its unique name

Retrieve Document Index

Used to retrieve a list of Document Indexes.

The initial index from which to return the results.

Which field to use when ordering the results.

Search for document indices by name or label

List Document Indexes

Used to partial update a Document Index given its ID or name.

Update Document Index

Used to fully update a Document Index given its ID or name.

Replace Document Index

Used to delete a Document Index given its ID or name.

Delete Document Index

Document Indexes

UploadDocumentBodyRequest

Upload Document

Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.

Retrieve Document

Used to list documents. Optionally filter on supported fields.

Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.

List Documents

Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.

Update Document

Delete a Document, keying off of either its Vellum-generated ID or its external ID.

Delete Document

Documents

List the Test Cases associated with a Test Suite

List Test Cases

Upsert Test Cases

Created, replace, and delete Test Cases within the specified Test Suite in bulk

Bulk Update Test Cases

Deletes an existing test case for a test suite, keying off of the test case id.

Delete Test Case

Test Cases

Trigger a Test Suite and create a new Test Suite Run

Create Test Suite Run

Retrieve Test Suite Run

List Test Suite Executions

Test Suite Runs

Test Suites

Add Entity To Folder

Folder Entities

AddOpenaiApiKeyEnum

A Node Result Event emitted from an API Node.

ApiNodeResult

ApiNodeResultData

ArrayChatMessageContent

ArrayChatMessageContentItem

ArrayChatMessageContentItemRequest

ArrayChatMessageContentRequest

ArrayVariableValueItem

ArrayVellumValueItem

ArrayVellumValueItemRequest

Basic vectorizer for intfloat/multilingual-e5-large.

BasicVectorizerIntfloatMultilingualE5Large

BasicVectorizerIntfloatMultilingualE5LargeRequest

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.

BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1

BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.

BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1

BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request

A user input representing a list of chat messages

ChatHistoryInputRequest

The variable's name, as defined in the deployment.

ChatMessage

An optional identifier representing who or what generated this message.

ChatMessageContent

ChatMessageContentRequest

ChatMessageRequest

ChatMessageRole

CodeExecutionNodeArrayResult

CodeExecutionNodeChatHistoryResult

CodeExecutionNodeErrorResult

CodeExecutionNodeFunctionCallResult

CodeExecutionNodeJsonResult

CodeExecutionNodeNumberResult

A Node Result Event emitted from a Code Execution Node.

CodeExecutionNodeResult

CodeExecutionNodeResultData

CodeExecutionNodeResultOutput

CodeExecutionNodeSearchResultsResult

CodeExecutionNodeStringResult

CompilePromptDeploymentExpandMetaRequest

If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt.

If enabled, the response will include the release tag of the Prompt Deployment.

If enabled, the response will include the ID of the Prompt Version backing the deployment.

CompilePromptMeta

A Node Result Event emitted from a Conditional Node.

ConditionalNodeResult

ConditionalNodeResultData

Information about the Test Case to create

CreateTestSuiteTestCaseRequest

A human-readable label used to convey the intention of this Test Case

Values for each of the Test Case's input variables

Values for each of the Test Case's evaluation variables

Optionally provide an ID that uniquely identifies this Test Case in your system. Useful for updating this Test Cases data after initial creation. Cannot be changed later.

DeploymentProviderPayloadResponse

DeploymentProviderPayloadResponsePayload

DeploymentRead

A human-readable label for the deployment

A name that uniquely identifies this deployment within its workspace

A human-readable description of the deployment

The ID of the history item associated with this Deployment's LATEST Release Tag

DeploymentReleaseTagDeploymentHistoryItem

DeploymentReleaseTagRead

The Deployment History Item that this Release Tag is associated with

DocumentDocumentToDocumentIndex

Vellum-generated ID that uniquely identifies this link.

Vellum-generated ID that uniquely identifies the index this document is included in.

DocumentIndexChunking

DocumentIndexChunkingRequest

DocumentIndexIndexingConfig

DocumentIndexIndexingConfigRequest

DocumentIndexRead

A human-readable label for the document index

A name that uniquely identifies this index within its workspace

DocumentRead

The unique id of this document as it exists in the user's system.

A human-readable label for the document. Defaults to the originally uploaded file's file name.

A previously supplied JSON object containing metadata that can be filtered on when searching.

DocumentStatus

EntityStatus

EnvironmentEnum

ErrorVariableValue

ErrorVellumValue

ErrorVellumValueRequest

ExecutePromptApiErrorResponse

ExecutePromptEvent

ExecutePromptResponse

ExecuteWorkflowErrorResponse

ExecuteWorkflowResponse

ExecuteWorkflowStreamErrorResponse

ExecuteWorkflowWorkflowResultEvent

A value representing an array of Vellum variable values.

ExecutionArrayVellumValue

The variable's uniquely identifying internal id.

ExecutionChatHistoryVellumValue

ExecutionErrorVellumValue

ExecutionFunctionCallVellumValue

ExecutionJsonVellumValue

ExecutionNumberVellumValue

ExecutionSearchResultsVellumValue

ExecutionStringVellumValue

ExecutionVellumValue

ExternalTestCaseExecution

The output values of a callable that was executed against a Test Case outside of Vellum

ExternalTestCaseExecutionRequest

FinishReasonEnum

FulfilledEnum

The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.

1	curl -X POST https://predict.vellum.ai/v1/submit-completion-actuals \
2	-H "X_API_KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"actuals": [
6	{}
7	]
8	}'