Client SDKPromptsPrompt Deployments

Retrieve Prompt Deployment

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

Path parameters

idstringRequired
Either the Prompt Deployment's ID or its unique name

Headers

X-API-KEYstringRequired
X-API-VersionstringOptional

Response

idstringformat: "uuid"
createdstringformat: "date-time"
labelstring<=150 characters

A human-readable label for the deployment

namestring<=150 characters
A name that uniquely identifies this deployment within its workspace
last_deployed_onstringformat: "date-time"
input_variableslist of objects
last_deployed_history_item_idstringformat: "uuid"
The ID of the history item associated with this Deployment's LATEST Release Tag
active_model_version_idslist of strings or nullDeprecated
Deprecated. This now always returns an empty array.
statusenum or null

The current status of the deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values:
environmentenum or null
Deprecated. The value returned will always be 'PRODUCTION'.
Allowed values:
descriptionstring or null

A human-readable description of the deployment