Prompts

Execute Prompt

GA
POST
Executes a deployed Prompt and returns the result.

Request

This endpoint expects an object.
inputs
list of unionsRequired
A list consisting of the Prompt Deployment's input variables and their values.
prompt_deployment_id
stringOptional

The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.

prompt_deployment_name
stringOptional

The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id.

release_tag
stringOptional
Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
external_id
stringOptional
Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
expand_meta
objectOptional

An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the meta key of the API response.

raw_overrides
objectOptional

Overrides for the raw API request sent to the model host. Combined with expand_raw, it can be used to access new features from models.

expand_raw
list of stringsOptional

A list of keys whose values you’d like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the raw key of the API response.

metadata
map from strings to anyOptional
Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.

Response

This endpoint returns a union
Fulfilled
OR
Rejected
Built with