prompt-templates

Get Prompt Template Raw Data

get/prompt-templates/{identifier}

Request

Base URL
https://docs.promptlayer.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/promptlayer/apis/promptlayer-api/docs/prompt-templates/:identifier/get.ts
A function with typed inputs. Its response is checked against the schema.

identifierstring required

The identifier can be either the prompt name or the prompt id.

versioninteger

Specific version number to retrieve. Mutually exclusive with label.

labelstring

Release label name to retrieve (e.g. 'prod', 'staging'). Mutually exclusive with version.

resolve_snippetsboolean

When true (default), snippets are expanded in the returned prompt_template. When false, raw @@@snippet@@@ references are preserved.

include_llm_kwargsboolean

When true, includes provider-specific llm_kwargs in the response. Requires model metadata to be set on the template.

Successful Response

successboolean required

idinteger required

The prompt template ID.

prompt_namestring required

The name of the prompt template.

versioninteger required

The version number of the prompt template.

workspace_idinteger required

The workspace this prompt template belongs to.

commit_messagestring nullable

The commit message for this version.

tagsstring[]

Tags associated with the prompt template.

created_atstring date-time nullable

Timestamp when this version was created.

llm_kwargsobject nullable

Provider-specific LLM arguments. Only present when include_llm_kwargs=true. Structure is provider-specific and may change without notice.

No recorded changes to this operation across all 3 revisions of this API.