GET /v1/prompts/:promptId

Summary

This endpoint retrieves metadata about a published prompt. By default, it returns the latest published version; you can request a specific version by providing the optional versionId query parameter. The response includes the prompt's version identifier, title, publication timestamp, and input configuration.

HTTP Request

GET /v1/prompts/:promptId?versionId=<versionId>

Path parameters

Parameter	Type	Required	Description
promptId	string	Yes	Unique identifier for the published prompt.

Query parameters

Parameter	Type	Required	Description
versionId	string	No	Identifier of a specific prompt version. When omitted, the latest published version is returned.

Response

Success (200 OK)

When the prompt exists, the server returns a JSON object whose status is "SUCCESS" and a data field containing the prompt metadata.

Field	Type	Description
promptVersionId	string	Identifier of the returned prompt version.
promptId	string	Identifier of the published prompt.
title	string	Human-readable title of the prompt.
publishedAt	string (ISO 8601)	Timestamp when the version was published.
config	object	Input configuration metadata for the prompt.

Example response

{
  "status": "SUCCESS",
  "data": {
    "promptVersionId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "promptId": "01234567-89ab-cdef-0123-456789abcdef",
    "title": "Image caption generator",
    "publishedAt": "2025-08-27T12:34:56.789Z",
    "config": {}
  }
}

Error responses

HTTP status	status code	Description
422	VALIDATION_ERROR	Invalid UUID or parameters.
404	NOT_FOUND_ERROR	The prompt/version does not exist.

See also

• Retrieve a prompt version: GET /v1/prompt-versions/:promptVersionId
• Run a prompt: POST /v1/runs