Get prompt by id | Opik Documentation

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

{
  "name": "string",
  "id": "string",
  "description": "string",
  "template_structure": "text",
  "tags": [
    "string"
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "version_count": 1,
  "latest_version": {
    "template": "string",
    "id": "string",
    "prompt_id": "string",
    "commit": "string",
    "metadata": {},
    "type": "mustache",
    "change_description": "string",
    "tags": [
      "string"
    ],
    "variables": [
      "string"
    ],
    "template_structure": "text",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "string"
  }
}

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 nullRead-onlyformat: "date-time"

created_bystring or nullRead-only

last_updated_atstring or nullRead-onlyformat: "date-time"

last_updated_bystring or nullRead-only

version_countlong or nullRead-only

latest_versionobject or null

Path parameters

Response

Errors