Skip to main content
GET
Read prompt source

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

prompt_id
string
required

Prompt identifier

Query Parameters

source_target_kind
string

Source to read the prompt file from: project or preview_branch. Falls back to runtime_target_kind when omitted.

runtime_target_kind
enum<string> | null

Used as the source target kind when source_target_kind is omitted.

Available options:
main_branch,
environment,
preview_branch,
null
target_environment_id
string<uuid> | null

Not supported for source reads; a non-null value is rejected.

target_branch_id
string<uuid> | null

Preview branch to use. Required for the preview_branch target; rejected for any other target.

Response

Prompt document

id
string
required
name
string
required
description
string | null
required
content
string | null
required
source_path
string
required
source
string
required
edit_mode
enum<string>
required
Available options:
structured,
source_only
source_only_reasons
string[]
required