Skip to main content
GET
/
v2
/
prompts
/
{prompt_id}
/
versions
/
{version_id}
Retrieve a prompt version
curl --request GET \
  --url https://api.orq.ai/v2/prompts/{prompt_id}/versions/{version_id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "prompt_config": {
    "stream": true,
    "model": "<string>",
    "model_db_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "model_type": "chat",
    "model_parameters": {
      "temperature": 123,
      "maxTokens": 123,
      "topK": 123,
      "topP": 123,
      "frequencyPenalty": 123,
      "presencePenalty": 123,
      "numImages": 123,
      "seed": 123,
      "format": "url",
      "dimensions": "<string>",
      "quality": "<string>",
      "style": "<string>",
      "responseFormat": {
        "type": "json_schema",
        "json_schema": {
          "name": "<string>",
          "description": "<string>",
          "strict": true,
          "schema": {}
        }
      },
      "photoRealVersion": "v1",
      "encoding_format": "float",
      "reasoningEffort": "disable",
      "budgetTokens": 123,
      "verbosity": "low"
    },
    "provider": "cohere",
    "integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": "<string>",
    "messages": [
      {
        "role": "system",
        "content": "<string>",
        "tool_calls": [
          {
            "id": "<string>",
            "index": 123,
            "type": "function",
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            }
          }
        ],
        "tool_call_id": "<string>"
      }
    ]
  },
  "metadata": {
    "language": "English"
  },
  "timestamp": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

prompt_id
string
required

The unique identifier of the prompt

version_id
string
required

The unique identifier of the prompt version

Response

Prompt version retrieved successfully.

_id
string
required
prompt_config
object
required

A list of messages compatible with the openAI schema

timestamp
string
required
created_by_id
string<uuid> | null
updated_by_id
string<uuid> | null
description
string | null

The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose

metadata
object