Optiverse Academy

Protocol Templates

List all protocol templates on your account.

GET /v1/protocol-templates

Returns all protocol templates available to you. Each template produces either structured (JSON) or unstructured (Markdown) summaries — use the summaryType field to know which endpoint to call.

Response

{
  "success": true,
  "data": [
    {
      "protocolId": "b7c4c322-2fd4-474b-8937-b46ff465e0af",
      "title": "Meeting Minutes",
      "description": "Extracts action items and decisions",
      "summaryType": "structured",
      "managedBy": "optiverse",
      "createdAt": "2025-03-01T12:00:00Z"
    },
    {
      "protocolId": "eefc041d-58ea-4f8f-9119-fd4e9315ff0e",
      "title": "Executive Summary",
      "description": "Free-form markdown summary",
      "summaryType": "unstructured",
      "managedBy": "user",
      "createdAt": "2025-06-15T09:00:00Z"
    }
  ]
}

Fields

FieldDescription
protocolIdUse this when calling the summaries endpoints
summaryType"structured" → use /v1/summaries/structured. "unstructured" → use /v1/summaries/unstructured
managedBy"optiverse" for built-in templates, "user" for your custom ones

Examples

cURL
curl -X GET "https://api.optiverse.ai/external-api/v1/protocol-templates" \
  -H "Authorization: Bearer optiuser_v1_your_key_here"

On this page