Deployments

Retrieve Provider Payload

POST

Request

This endpoint expects an object.
inputs
list of unionsRequired
The list of inputs defined in the Prompt's deployment with their corresponding values.
deployment_id
stringOptional

The ID of the deployment. Must provide either this or deployment_name.

deployment_name
stringOptional

The name of the deployment. Must provide either this or deployment_id.

release_tag
stringOptional
Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment

Response

This endpoint returns an object
payload
map from strings to any
POST
1curl -X POST https://api.vellum.ai/v1/deployments/provider-payload \
2     -H "X_API_KEY: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "inputs": []
6}'
200
Successful
1{
2  "payload": {
3    "payload": {
4      "key": "value"
5    }
6  }
7}
Built with