Get prompt by commit | Opik Documentation

1	curl http://localhost:5173/api/v1/private/prompts/by-commit/commit

{
  "name": "string",
  "id": "string",
  "project_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"
  },
  "requested_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 commit

Path parameters

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

Response

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

400

Bad Request Error

404

Not Found Error

409

Conflict Error