Retrieve Prompt Deployment Release | Vellum

1 curl https://api.vellum.ai/v1/deployments/id/releases/release_id_or_release_tag \ 2 -H "X-API-KEY: <X-API-KEY>"

1 { 2 "id": "foo", 3 "created": "foo", 4 "environment": { 5 "id": "foo", 6 "name": "foo", 7 "label": "foo" 8 }, 9 "prompt_version": { 10 "id": "foo", 11 "build_config": { 12 "source": "SANDBOX", 13 "sandbox_id": "foo", 14 "sandbox_snapshot_id": "foo", 15 "prompt_id": "foo" 16 } 17 }, 18 "deployment": { 19 "name": "foo" 20 }, 21 "release_tags": [ 22 { 23 "name": "foo", 24 "source": "SYSTEM" 25 } 26 ], 27 "reviews": [ 28 { 29 "id": "foo", 30 "created": "foo", 31 "reviewer": { 32 "id": "foo", 33 "full_name": "foo" 34 }, 35 "state": "APPROVED" 36 } 37 ], 38 "created_by": { 39 "id": "foo", 40 "email": "foo", 41 "full_name": "foo" 42 }, 43 "description": "foo" 44 }

Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.

Path parameters

idstringRequired

Either the Prompt Deployment's ID or its unique name

release_id_or_release_tagstringRequired

Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.

Response

idstringformat: "uuid"

createdstringformat: "date-time"

environmentobject

prompt_versionobject

deploymentobject

release_tagslist of objects

reviewslist of objects

created_byobject or null

descriptionstring or null

Path parameters

Headers

Response