Deployments

Retrieve Provider Payload

POST
https://api.vellum.ai/v1/deployments/provider-payload

Request

This endpoint expects an object.
inputs
list of unions
The list of inputs defined in the Prompt's deployment with their corresponding values.
deployment_id
optional string
The ID of the deployment. Must provide either this or deployment_name.
deployment_name
optional string
The name of the deployment. Must provide either this or deployment_id.

Response

This endpoint return an object.
payload
map from strings to any
POST
/v1/deployments/provider-payload
curl -X POST https://api.vellum.ai/v1/deployments/provider-payload \
-H "X_API_KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"inputs": []
}'
Response
{
"payload": {
"payload": {
"key": "value"
}
}
}