Create analysis template

POST

https://api.hmsovereign.com/api/v1/analysis-templates

Analysis Templates

Last modified:2026-01-30 13:43:45

Maintainer:Jesper Rietbergen

Create a new analysis template for your organization

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Analysis template created successfully

Body

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.hmsovereign.com/api/v1/analysis-templates' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Lead Qualification",
    "description": "Qualify sales leads based on call content",
    "system_prompt": "You are a sales analyst. Extract lead qualification information from sales calls.",
    "user_prompt": "Analyze this sales call and extract: budget mentioned, timeline, decision maker involvement, and pain points.\n\nTranscript: {transcript}",
    "schema": {
        "type": "object",
        "properties": {
            "budget_mentioned": {
                "type": "boolean",
                "description": "Whether budget was discussed"
            },
            "timeline": {
                "type": "string",
                "description": "Expected timeline for purchase"
            },
            "decision_maker": {
                "type": "boolean",
                "description": "Whether speaking with decision maker"
            }
        }
    },
    "is_active": true
}'

Response Example

201 - Example 1

{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "org_id": "7461b868-afc1-4fe2-871a-5e7c0f3d5772",
    "name": "Customer Satisfaction Survey",
    "description": "Extract customer satisfaction metrics and feedback from support calls",
    "system_prompt": "You are analyzing a customer service call. Extract key satisfaction indicators and feedback.",
    "user_prompt": "Analyze this call transcript and extract: customer satisfaction level, main issues discussed, and whether the issue was resolved.\n\nTranscript: {transcript}",
    "schema": {
        "type": "object",
        "properties": {
            "satisfaction_level": {
                "type": "string",
                "description": "Overall customer satisfaction",
                "enum": [
                    "very_satisfied",
                    "satisfied",
                    "neutral",
                    "dissatisfied",
                    "very_dissatisfied"
                ]
            },
            "main_issues": {
                "type": "array",
                "description": "List of issues discussed during the call"
            },
            "issue_resolved": {
                "type": "boolean",
                "description": "Whether the customer's issue was resolved"
            }
        }
    },
    "is_active": true,
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-01-15T10:00:00Z"
}

Modified at 2026-01-30 13:43:45

List analysis templates

Get analysis template