---
title: "Get Template"
method: GET
path: "/api/v1/templates/{template_id}"
tags: ["templates"]
---

# Get Template

`GET /api/v1/templates/{template_id}`

## Request

- Base URL: `https://interactions-api.soulmachines.cloud` (the document declares no server; this is the origin it was published from)
- URL: `https://interactions-api.soulmachines.cloud/api/v1/templates/{template_id}`
- Auth: none declared

## Path parameters

- `template_id` string, required

## Headers

- `x-api-key` string

## Response `200`

Successful Response

- Template
  - `template_name` string, required
  - `user_id` string, nullable
  - `purpose` string, required
  - `metadata` object, nullable
  - `objectives` string, nullable
  - `auto_end_session` boolean, nullable
  - `name` string, required
  - `avatar` string, nullable
  - `style_id` string, nullable
  - `voice_id` string, nullable
  - `created_by_key_id` string, nullable
  - `response_length` 'concise' | 'moderate' | 'detailed'
  - `results` object, nullable
  - `role` string, nullable
  - `tone` string, nullable
  - `context` object, nullable
  - `knowledge_snippet` string, nullable
  - `template_type` string, nullable
  - `parent_template_id` string, nullable
  - `tags` string[], nullable
  - `context_mapping` object, nullable
  - `results_mapping` object, nullable
  - `auth_settings` AuthSettings
    - `require_wf_org_authentication` boolean
  - `timezone` string, nullable
  - `deleted_at` string, nullable
  - `is_deleted` boolean
  - `welcome_message` string, nullable
  - `topics_to_avoid` string, nullable
  - `prompt` string, nullable
  - `seed_memory` string, nullable
  - `behaviour_style` string, nullable
  - `generative_gestures` string, nullable
  - `conversation_start_prompt` string, nullable
  - `webhook` Webhook
    - `url` string, required
    - `method` string, nullable
    - `headers` object, nullable
    - `body` object, nullable
  - `template_id` string, required
  - `organization_id` string, nullable
  - `created_at` string, required
  - `updated_at` string, required
  - `failure_reason` string, nullable
  - `image` string, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-22** `0a1163b31188`: 5 info
  - added the optional property `behaviour_style` to the response with the `200` status
  - added the optional property `conversation_start_prompt` to the response with the `200` status
  - added the optional property `generative_gestures` to the response with the `200` status
  - added the optional property `prompt` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/soulmachines/apis/soul-machines-interactions-api/changes/api/v1/templates/:template_id/get.md)

---

[API](https://skmtc.dev/soulmachines/apis/soul-machines-interactions-api.md) - [All operations](https://skmtc.dev/soulmachines/apis/soul-machines-interactions-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soulmachines/apis/soul-machines-interactions-api/revisions/ede891b8801e?raw)