Skip to navigation
Client SDKPrompts

Pull Prompt

Beta

Used to pull the definition of a Prompt from Vellum.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
The ID of the Prompt to pull from. Prompt Deployment IDs or names, Prompt Sandbox IDs, and Prompt Version IDs are currently supported.

Headers

X-API-VersionstringOptional
AcceptstringOptionalDefaults to application/json

Set to 'application/yaml' to receive YAML response, otherwise JSON will be returned

Query parameters

prompt_variant_idstringOptional
The ID of the Prompt Variant within a Prompt Sandbox to pull. Must be included if providing the ID of a Prompt Sandbox.
release_tagstringOptional
The Release Tag to pull when providing a Prompt Deployment ID or name. Defaults to LATEST.

Response

This endpoint returns an object.
ml_modelstring
input_variableslist of objects
parametersobject
blockslist of objects
settingsobject or nullOptional
functionslist of objects or nullOptional

Errors

400
Bad Request Error
404
Not Found Error