Get Template

Sprint 3

Get template details by ID.

Endpoint

GET /api/v1/prompt-templates/{template_id}

Headers

Header	Required	Description
Authorization	Yes	Bearer <access_token>

Path Parameters

Parameter	Type	Required	Description
template_id	integer	Yes	Template ID

Response

Success (200)

{
  "success": true,
  "data": {
    "id": 1,
    "organization_id": 1,
    "name": "Sales Report Template",
    "description": "Template for generating sales reports",
    "template_text": "Show me {{metric}} for {{time_period}}",
    "parameters": [
      {
        "name": "metric",
        "type": "string",
        "required": true,
        "description": "Metric to report on"
      },
      {
        "name": "time_period",
        "type": "string",
        "required": true,
        "default": "last_30_days"
      }
    ],
    "category": "reports",
    "tags": ["sales", "report"],
    "icon_url": "https://example.com/icon.png",
    "icon_presigned_url": "https://storage.example.com/...",
    "status": "published",
    "compatible_data_source_ids": [1, 2],
    "is_system_template": false,
    "is_public": true,
    "usage_count": 25,
    "created_by_user_id": 1,
    "created_at": "2024-12-01T08:00:00Z",
    "updated_at": "2024-12-01T10:00:00Z"
  },
  "message": "Template retrieved successfully"
}

Error Codes

Status	Code	Description
401	UNAUTHORIZED	Invalid or missing authentication token
404	NOT_FOUND	Template not found

Features

• Returns complete template configuration
• Includes parameter definitions
• Shows usage count
• Organization-scoped access control

Example

curl -X GET "https://api.rivergen.com/api/v1/prompt-templates/1" \
  -H "Authorization: Bearer <access_token>"

Related Endpoints

• List Templates - List all templates
• Execute Template - Execute this template