Get prompt by id | Opik Documentation

1 curl http://localhost:5173/api/v1/private/prompts/id

1 { 2 "name": "string", 3 "id": "string", 4 "description": "string", 5 "template_structure": "text", 6 "tags": [ 7 "string" 8 ], 9 "created_at": "2024-01-15T09:30:00Z", 10 "created_by": "string", 11 "last_updated_at": "2024-01-15T09:30:00Z", 12 "last_updated_by": "string", 13 "version_count": 1, 14 "latest_version": { 15 "template": "string", 16 "id": "string", 17 "prompt_id": "string", 18 "commit": "string", 19 "metadata": {}, 20 "type": "mustache", 21 "change_description": "string", 22 "tags": [ 23 "string" 24 ], 25 "variables": [ 26 "string" 27 ], 28 "template_structure": "text", 29 "created_at": "2024-01-15T09:30:00Z", 30 "created_by": "string" 31 } 32 }

Get prompt by id

Path parameters

idstringRequiredformat: "uuid"

Response

Prompt resource

namestring>=1 character

idstring or nullformat: "uuid"

descriptionstring or nullformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters

template_structureenum or nullDefaults to text

Template structure type: ‘text’ or ‘chat’. Immutable after creation.

Allowed values:

tagslist of strings or null

created_atstring or nullformat: "date-time"

created_bystring or null

last_updated_atstring or nullformat: "date-time"

last_updated_bystring or null

version_countlong or null

latest_versionobject or null

Path parameters

Response

Errors