v1

latestOpenAPI 3.1.02026-08-06121424.1 KB

templates

Get Template

get/api/v1/templates/{template_id}

Path parameters

template_idstring required

Headers

x-api-keystring

Response

Successful Response

template_namestring required

user_idstring nullable

purposestring required

metadataobject nullable

objectivesstring nullable

auto_end_sessionboolean nullable

namestring required

avatarstring nullable

style_idstring nullable

voice_idstring nullable

created_by_key_idstring nullable

response_length'concise' | 'moderate' | 'detailed'

resultsobject nullable

rolestring nullable

tonestring nullable

contextobject nullable

knowledge_snippetstring nullable

template_typestring nullable

parent_template_idstring nullable

tagsstring[] nullable

context_mappingobject nullable

results_mappingobject nullable

timezonestring nullable

deleted_atstring nullable

is_deletedboolean

welcome_messagestring nullable

topics_to_avoidstring nullable

template_idstring required

organization_idstring nullable

created_atstring required

updated_atstring required

failure_reasonstring nullable

imagestring required