Skip to main content
GET
Get Prompt

Authorizations

X-API-Key
string
header
required

API Key for external integrations (format: greetincs_...)

Path Parameters

prompt_id
string
required

Prompt ID in TypeID format (unversioned: prompt_xxx)

Response

Successful Response

API response model for structured prompts.

data
PromptData · object
required

Data model for versioned structured prompts.

The id field serializes as unversioned (prompt_xxx) for direct use in API paths. Version info is in the separate version field.

response_type
string
default:PromptResponse

HATEOAS links related to this response (e.g., self, next, prev)

Example: