Retrieve Prompt Deployment

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

Path parameters

idstringRequired
Either the Deployment's ID or its unique name

Response

This endpoint returns an object.
idstring
createddatetime
labelstring
A human-readable label for the deployment
namestring
A name that uniquely identifies this deployment within its workspace
last_deployed_ondatetime
input_variableslist of objects
last_deployed_history_item_idstring
The ID of the history item associated with this Deployment's LATEST Release Tag
active_model_version_idslist of stringsDeprecated

Deprecated. The Prompt execution endpoints return a prompt_version_id that could be used instead.

status"ACTIVE" or "ARCHIVED"Optional
Allowed values: ACTIVEARCHIVED

The current status of the deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
environmentenumOptional
Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
descriptionstringOptional
A human-readable description of the deployment
Built with