Skip to main content
GET
/
prompts
/
{slug}
curl -X GET https://app.tracia.io/api/v1/prompts/welcome-email \
  -H "Authorization: Bearer tr_your_api_key"
{
  "id": "clx1abc123",
  "slug": "welcome-email",
  "name": "Welcome Email",
  "description": "A welcome email template",
  "provider": "OPENAI",
  "model": "gpt-4",
  "temperature": 0.7,
  "topP": null,
  "maxOutputTokens": null,
  "currentVersion": 3,
  "content": [
    {
      "id": "msg_1",
      "role": "system",
      "content": "You are a helpful assistant that writes professional emails."
    },
    {
      "id": "msg_2",
      "role": "user",
      "content": "Write a welcome email for {{name}} who just signed up for {{product}}."
    }
  ],
  "variables": ["name", "product"],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-20T14:22:00.000Z"
}

Request

Authorization
string
required
Bearer token with your API key: Bearer tr_your_api_key
slug
string
required
The prompt slug

Response

id
string
Unique identifier for the prompt
slug
string
URL-friendly identifier
name
string
Display name of the prompt
description
string | null
Description of the prompt
provider
string | null
Model provider: OPENAI, ANTHROPIC, or GOOGLE
model
string | null
Default model for this prompt
temperature
number | null
Temperature setting for the model (0-2)
topP
number | null
Top-p (nucleus) sampling setting (0-1)
maxOutputTokens
number | null
Maximum output tokens limit
currentVersion
number
Current version number
content
array
Array of prompt messages
variables
string[]
List of template variables extracted from content
createdAt
string
ISO 8601 timestamp of creation
updatedAt
string
ISO 8601 timestamp of last update
curl -X GET https://app.tracia.io/api/v1/prompts/welcome-email \
  -H "Authorization: Bearer tr_your_api_key"
{
  "id": "clx1abc123",
  "slug": "welcome-email",
  "name": "Welcome Email",
  "description": "A welcome email template",
  "provider": "OPENAI",
  "model": "gpt-4",
  "temperature": 0.7,
  "topP": null,
  "maxOutputTokens": null,
  "currentVersion": 3,
  "content": [
    {
      "id": "msg_1",
      "role": "system",
      "content": "You are a helpful assistant that writes professional emails."
    },
    {
      "id": "msg_2",
      "role": "user",
      "content": "Write a welcome email for {{name}} who just signed up for {{product}}."
    }
  ],
  "variables": ["name", "product"],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-20T14:22:00.000Z"
}

Authorizations

Authorization
string
header
required

API key starting with tr_

Path Parameters

slug
string
required

The prompt slug

Response

Successful response

id
string

Unique identifier for the prompt

slug
string

URL-friendly identifier

name
string

Display name of the prompt

description
string | null

Description of the prompt

provider
enum<string> | null

Model provider

Available options:
OPENAI,
ANTHROPIC,
GOOGLE
model
string | null

Default model for this prompt

temperature
number | null

Temperature setting for the model (0-2)

topP
number | null

Top-p (nucleus) sampling setting (0-1)

maxOutputTokens
integer | null

Maximum output tokens limit

currentVersion
integer

Current version number

content
object[]

Array of prompt messages

variables
string[]

List of template variables extracted from content

createdAt
string<date-time>

ISO 8601 timestamp of creation

updatedAt
string<date-time>

ISO 8601 timestamp of last update