Skip to content

GET /v1/prompt-versions/:promptVersionId

Summary

Retrieve metadata for a specific prompt version. Use this endpoint when you already know the promptVersionId and need to inspect its input configuration before creating a run.

HTTP Request

http
GET /v1/prompt-versions/:promptVersionId

Path parameters

ParameterTypeRequiredDescription
promptVersionIdstringYesUnique identifier of the prompt version.

Response

Success (200 OK)

Returns a JSON object whose status is "SUCCESS" and a data object containing:

FieldTypeDescription
promptVersionIdstringIdentifier of the prompt version.
promptIdstringIdentifier of the parent prompt.
titlestringTitle of the prompt.
publishedAtstring (ISO 8601)When this version was published.
configobjectInput configuration metadata for the prompt.

Example response

json
{
  "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 statusstatus codeDescription
422VALIDATION_ERRORInvalid UUID format.
404NOT_FOUND_ERRORThe prompt version does not exist.

See also