Appearance
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/:promptVersionIdPath parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
promptVersionId | string | Yes | Unique identifier of the prompt version. |
Response
Success (200 OK)
Returns a JSON object whose status is "SUCCESS" and a data object containing:
| Field | Type | Description |
|---|---|---|
promptVersionId | string | Identifier of the prompt version. |
promptId | string | Identifier of the parent prompt. |
title | string | Title of the prompt. |
publishedAt | string (ISO 8601) | When this version was published. |
config | object | Input 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 status | status code | Description |
|---|---|---|
422 | VALIDATION_ERROR | Invalid UUID format. |
404 | NOT_FOUND_ERROR | The prompt version does not exist. |
See also
- Get prompt metadata:
GET /v1/prompts/:promptId - Run a prompt:
POST /v1/runs