Skip to main content
GET
Get a prompt

Authorizations

x-api-key
string
header
required

Project API key. Manage keys in the Zespan dashboard under project settings.

Path Parameters

name
string
required

Prompt name.

Query Parameters

version
integer

Fetch a specific version.

Required range: x >= 1
label
string

Fetch the version currently carrying this label (e.g. production).

projectId
string<uuid>

Project id. Optional and ignored when authenticating with an API key, since the key already scopes the request to one project.

Response

The resolved prompt.

A single prompt version.

id
string<uuid>
projectId
string<uuid>
name
string
Example:

"support-reply"

version
integer
Example:

3

type
enum<string>
Available options:
text,
chat
prompt

Prompt content — a string for text prompts, or an array of chat messages.

config
object
labels
string[]
Example:
tags
string[]
folder
string | null
commitMessage
string | null
createdBy
string
createdAt
string<date-time>
updatedAt
string<date-time>
resolvedPrompt
any | null

Prompt content with dependencies inlined (present on single-prompt fetch).