Skip to main content
GET
/
v1
/
prompts
/
{prompt_id}
Get Prompt
curl --request GET \
  --url https://api.example.com/v1/prompts/{prompt_id} \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "prompt": "<string>",
    "response_schema": {
      "draft_07": {}
    },
    "version": 123,
    "is_current": true,
    "created_at": 123,
    "description": "<string>"
  },
  "response_type": "PromptResponse",
  "links": []
}

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
​
links
Link · object[]

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

Example:
[
  {
    "href": "/resource/{resource_id}",
    "method": "GET",
    "rel": "self",
    "title": "Resource Details"
  },
  {
    "href": "/resource/{resource_id}/related",
    "method": "GET",
    "rel": "related",
    "title": "Related Resources"
  }
]