Get prompt by commit | Opik Documentation

using RestSharp;
var client = new RestClient("http://localhost:5173/api/v1/private/prompts/by-commit/commit");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

{
  "name": "Customer Support Response",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "Template for generating customer support replies based on user queries.",
  "template_structure": "text",
  "tags": [
    "support",
    "customer-service"
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "jane.doe@example.com",
  "last_updated_at": "2024-04-10T14:45:00Z",
  "last_updated_by": "john.smith@example.com",
  "version_count": 3,
  "latest_version": {
    "template": "Hello {{user_name}}, thank you for reaching out. We have received your request and will get back to you shortly.",
    "id": "7b9c2d4e-8f3a-4d2b-9a1e-5f6c7d8e9f01",
    "prompt_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "commit": "a1b2c3d4",
    "metadata": {
      "language": "en",
      "category": "support"
    },
    "type": "mustache",
    "change_description": "Updated greeting to be more friendly and personalized.",
    "tags": [
      "support",
      "friendly"
    ],
    "variables": [
      "user_name"
    ],
    "template_structure": "text",
    "created_at": "2024-04-10T14:45:00Z",
    "created_by": "john.smith@example.com"
  },
  "requested_version": {
    "template": "Hello {{user_name}}, thank you for reaching out. We have received your request and will get back to you shortly.",
    "id": "5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f89",
    "prompt_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "commit": "a1b2c3d4",
    "metadata": {
      "language": "en",
      "category": "support"
    },
    "type": "mustache",
    "change_description": "Updated greeting to be more friendly and personalized.",
    "tags": [
      "support",
      "friendly"
    ],
    "variables": [
      "user_name"
    ],
    "template_structure": "text",
    "created_at": "2024-04-10T14:45:00Z",
    "created_by": "john.smith@example.com"
  }
}

Get prompt by commit

Path parameters

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

Response

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_atdatetime or nullRead-only

created_bystring or nullRead-only

last_updated_atdatetime or nullRead-only

last_updated_bystring or nullRead-only

version_countlong or nullRead-only

latest_versionobject or null

requested_versionobject or null

Path parameters

Response

Errors