Retrieve prompt version

Request

This endpoint expects an object.

namestringRequired>=1 character

commitstringOptional

environmentstringOptionalformat: "^[A-Za-z0-9_-]+$"0-150 characters

If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit and version_number

version_numberstringOptionalformat: "v\d+"0-10 characters

If provided, resolves to the version with this sequential number (e.g. v3); mutually exclusive with commit and environment

project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

If provided, scopes the search to the specified project

Response

templatestring>=1 character

idstringformat: "uuid"

version unique identifier, generated if absent

prompt_idstringRead-onlyformat: "uuid"

commitstringformat: "^[a-zA-Z0-9]{8}$"

version short unique identifier, generated if absent. it must be 8 characters long

version_numberstringRead-only

sequential version number in the format v<N>; null for masks

metadataobject

typeenum

Allowed values:

version_typeenum

version type discriminator; defaults to prompt_version

Allowed values:

environmentstringformat: "^[A-Za-z0-9_-]+$"0-150 characters

change_descriptionstring

tagslist of strings

variableslist of stringsRead-only

template_structureenumRead-only

Allowed values:

created_atdatetimeRead-only

created_bystringRead-only

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

This endpoint expects an object.

If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit and version_number

If provided, resolves to the version with this sequential number (e.g. v3); mutually exclusive with commit and environment

If provided, scopes the search to the specified project

version unique identifier, generated if absent

version short unique identifier, generated if absent. it must be 8 characters long

sequential version number in the format v<N>; null for masks

version type discriminator; defaults to prompt_version

$	curl -X POST http://localhost:5173/api/v1/private/prompts/versions/retrieve \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "string"
>	}'

1	{
2	"template": "string",
3	"id": "string",
4	"prompt_id": "string",
5	"commit": "string",
6	"version_number": "string",
7	"metadata": {},
8	"type": "mustache",
9	"version_type": "prompt_version",
10	"environment": "string",
11	"change_description": "string",
12	"tags": [
13	"string"
14	],
15	"variables": [
16	"string"
17	],
18	"template_structure": "text",
19	"created_at": "2024-01-15T09:30:00Z",
20	"created_by": "string"
21	}

$	curl -X POST http://localhost:5173/api/v1/private/prompts/versions/retrieve \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "string"
>	}'

1	{
2	"template": "string",
3	"id": "string",
4	"prompt_id": "string",
5	"commit": "string",
6	"version_number": "string",
7	"metadata": {},
8	"type": "mustache",
9	"version_type": "prompt_version",
10	"environment": "string",
11	"change_description": "string",
12	"tags": [
13	"string"
14	],
15	"variables": [
16	"string"
17	],
18	"template_structure": "text",
19	"created_at": "2024-01-15T09:30:00Z",
20	"created_by": "string"
21	}