Get prompt by id | Opik Documentation

curl http://localhost:5173/api/v1/private/prompts/id \
     -H "Content-Type: application/json"

{
  "name": "Customer Support Greeting",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_id": "7e9f1d2a-4c3b-4f8a-9d2e-1a2b3c4d5e6f",
  "description": "A prompt template for greeting customers in support chat sessions.",
  "template_structure": "text",
  "tags": [
    "support",
    "greeting",
    "chatbot"
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "alice.jones",
  "last_updated_at": "2024-04-10T14:45:00Z",
  "last_updated_by": "bob.smith",
  "version_count": 3,
  "latest_version": {
    "template": "Hello {{customer_name}}, how can I assist you today?",
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "prompt_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "commit": "a1b2c3d4",
    "metadata": {
      "language": "en",
      "category": "greeting"
    },
    "type": "mustache",
    "change_description": "Updated greeting to include customer name variable.",
    "tags": [
      "support",
      "personalized"
    ],
    "variables": [
      "customer_name"
    ],
    "template_structure": "text",
    "created_at": "2024-04-10T14:45:00Z",
    "created_by": "bob.smith"
  },
  "requested_version": {
    "template": "Hello {{customer_name}}, how can I assist you today?",
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "prompt_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "commit": "a1b2c3d4",
    "metadata": {
      "language": "en",
      "category": "greeting"
    },
    "type": "mustache",
    "change_description": "Updated greeting to include customer name variable.",
    "tags": [
      "support",
      "personalized"
    ],
    "variables": [
      "customer_name"
    ],
    "template_structure": "text",
    "created_at": "2024-04-10T14:45:00Z",
    "created_by": "bob.smith"
  }
}

Get prompt by id

Path parameters

idstringRequiredformat: "uuid"

Response

Prompt resource

namestring>=1 character

idstringformat: "uuid"

project_idstringformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

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

template_structureenumDefaults to text

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

Allowed values:

tagslist of strings

created_atdatetimeRead-only

created_bystringRead-only

last_updated_atdatetimeRead-only

last_updated_bystringRead-only

version_countlongRead-only

latest_versionobject

requested_versionobject

Errors

404

Not Found Error