SOsoulmachines
templates

Get Template

Changed on
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)
  • Auth
    none declared

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
promptstring nullable
seed_memorystring nullable
behaviour_stylestring nullable
generative_gesturesstring nullable
conversation_start_promptstring nullable
template_idstring required
organization_idstring nullable
created_atstring required
updated_atstring required
failure_reasonstring nullable
imagestring required

Changes

  • 0a1163b31188Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status