{"openapi":"3.1.0","info":{"title":"Soul Machines Interactions API","description":"The Soul Machines Interactions API lets you create fully customized digital person interactions on demand — programmatically, at scale. Instead of pre-configuring static avatars, you define each interaction's context, purpose, personality, and tone in real time, then receive a unique, shareable URL to deliver that personalized experience to your end users.\n\n### How it works\n1.  **Make an API request** — Send a JSON payload describing who the digital person should be (avatar, name, role, tone) and what they should do (purpose, context, objectives).\n2.  **Get a unique URL** — The API responds with a secure interaction link you can embed, share, or open in a browser.\n3.  **Run the session** — Your end user talks to the digital person. When they finish, you can capture interaction results programmatically.\n\n### Why you'd use it\n*   **Deliver just-in-time personalization** — tailor conversations for each customer, scenario, or moment.\n*   **Scale without overhead** — no need to pre-create and maintain hundreds of static configurations.\n*   **Stay in control** — define goals, tone, and context dynamically to align the AI's behavior with your brand.\n\nThis flexible API-first approach makes it easy to orchestrate rich, personalized digital people experiences while keeping integration and backend logic clean and scalable.\n\nObtain an API key from [Soul Machines Digital Workforce Connect](https://workforce.soulmachines.com/).\n","version":"1.0.0"},"paths":{"/api/v1/generator":{"post":{"tags":["generator"],"summary":"Create Generator Interaction","description":"Generates a new Soul Machines interaction.\n\nThis endpoint is designed to receive specifications for an AI assistant (Digital Person),\nincluding its purpose, context, objectives, and expected results. It then uses an\nLLM (e.g., GPT-4) to generate the necessary system prompts, welcome messages,\nand structured objectives for the interaction.\n\nFor MCP server integration, this endpoint can be used to programmatically create\nand configure new Digital Person interactions/experiences based on predefined templates or\ndynamic inputs. The generated `interaction_url` is the expected output to the user asking to generate an interaction.","operationId":"create_generator_interaction_api_v1_generator_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratorRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteractionSummary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/people":{"get":{"tags":["digital-persons"],"summary":"Get All People","operationId":"get_all_people_api_v1_people_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DigitalPerson"},"type":"array","title":"Response Get All People Api V1 People Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tones":{"get":{"tags":["tones"],"summary":"Get Interaction Tones","operationId":"get_interaction_tones_api_v1_tones_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response Get Interaction Tones Api V1 Tones Get"}}}}}}},"/api/v1/gestures":{"get":{"tags":["gestures"],"summary":"Get Interaction Gestures","operationId":"get_interaction_gestures_api_v1_gestures_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response Get Interaction Gestures Api V1 Gestures Get"}}}}}}},"/api/v1/org":{"get":{"tags":["org"],"summary":"Get Org","operationId":"get_org_api_v1_org_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/response_lengths":{"get":{"tags":["response_lengths"],"summary":"Get Interaction Response Lengths","operationId":"get_interaction_response_lengths_api_v1_response_lengths_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response Get Interaction Response Lengths Api V1 Response Lengths Get"}}}}}}},"/api/v1/triggers/subscribe":{"post":{"tags":["triggers"],"summary":"Subscribe Trigger","operationId":"subscribe_trigger_api_v1_triggers_subscribe_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/triggers/unsubscribe":{"post":{"tags":["triggers"],"summary":"Unsubscribe Trigger","operationId":"unsubscribe_trigger_api_v1_triggers_unsubscribe_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerId"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/triggers/sample_data":{"get":{"tags":["triggers"],"summary":"Get Trigger Sample Data","operationId":"get_trigger_sample_data_api_v1_triggers_sample_data_get","parameters":[{"name":"trigger_id","in":"query","required":true,"schema":{"type":"string","title":"Trigger Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true},"title":"Response Get Trigger Sample Data Api V1 Triggers Sample Data Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/triggers/available":{"get":{"tags":["triggers"],"summary":"Get Available Trigger Names","operationId":"get_available_trigger_names_api_v1_triggers_available_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{},"title":"Response Get Available Trigger Names Api V1 Triggers Available Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/templates/{template_id}":{"get":{"tags":["templates"],"summary":"Get Template","operationId":"get_template_api_v1_templates__template_id__get","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/templates":{"get":{"tags":["templates"],"summary":"List Templates","description":"List all templates for the organization associated with the API key.","operationId":"list_templates_api_v1_templates_get","parameters":[{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Optional list of tags to filter templates by","title":"Tags"},"description":"Optional list of tags to filter templates by"},{"name":"include_deleted","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Deleted"}},{"name":"x-api-key","in":"header","required":false,"schema":{"type":"string","title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"},"title":"Response List Templates Api V1 Templates Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/health":{"get":{"tags":["health"],"summary":"Get Health Check","operationId":"get_health_check_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"Analytics":{"properties":{"wfOrgId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wforgid"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organizationid","description":"studio organization id","example":"1"},"wfGalleryId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wfgalleryid"},"wfAssistantId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wfassistantid"},"userId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"}},"type":"object","title":"Analytics"},"AuthSettings":{"properties":{"require_wf_org_authentication":{"type":"boolean","title":"Require Wf Org Authentication","default":false}},"type":"object","title":"AuthSettings"},"DigitalPerson":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"image":{"type":"string","title":"Image"},"transparent_image":{"type":"string","title":"Transparent Image"},"avatar_image":{"type":"string","title":"Avatar Image"},"image_jpg":{"type":"string","title":"Image Jpg"},"tone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tone"},"behaviour_style":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behaviour Style"},"appearance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appearance"},"environment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Environment"},"backstory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Backstory"},"generative_gestures":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generative Gestures"}},"type":"object","required":["id","name","image","transparent_image","avatar_image","image_jpg"],"title":"DigitalPerson"},"GeneratorRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The display name for the Digital Person in the conversation (e.g., 'Sarah'). If not provided, a default based on the avatar is used."},"role":{"type":"string","title":"Role","description":"The role the Digital Person will play (e.g., 'Customer Service Agent', 'Product Advisor')."},"tone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tone","description":"The desired conversational tone for the Digital Person (e.g., 'Friendly'). Friendly is the default tone."},"objectives":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Objectives","description":"A list of high-level objectives for the conversation to be executed in order (e.g., 'Collect user feedback', 'Troubleshoot an issue').","default":[]},"auto_end_session":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto End Session","description":"Automatically end the session after the last objective is completed. If not provided, defaults to True if objectives are present otherwise, defaults to False."},"results":{"additionalProperties":{"type":"string"},"type":"object","title":"Results","description":"A dictionary defining the key pieces of information the Digital Person should aim to collect or provide. Keys are identifiers, values are descriptions (e.g., {'user_email': 'The user's email address'})."},"parameters":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Parameters","description":"Optional parameters to be passed through to the webhook triggered at the end of the interaction.","default":{}},"event":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event","description":"An optional event name. If provided, a trigger with this name will be created/updated with sample data based on the 'results'."},"purpose":{"type":"string","title":"Purpose","description":"A detailed description of the overall purpose of this Digital Person interaction. This will be used to generate the system prompt."},"context":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Context","description":"Key-value pairs providing additional context for the AI to understand its environment or constraints or additional information.  This will be added with no changes as context to the system prompt.(e.g., {'Onboarding Information': 'information goes here'}).","default":{}},"knowledge_snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Knowledge Snippet","description":"An optional knowledge snippet that will be added directly to the Digital Person's interaction system prompt. This should be short and brief"},"context_mapping":{"anyOf":[{"additionalProperties":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object"},"type":"object"},{"type":"null"}],"title":"Context Mapping","description":"Optional input mapping for context field.","default":{}},"results_mapping":{"anyOf":[{"additionalProperties":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object"},"type":"object"},{"type":"null"}],"title":"Results Mapping","description":"Optional output mapping for results field.","default":{}},"base_web_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Base Web Url","description":"The base URL for constructing the interaction URL. Defaults to environment setting.","default":"https://workforce.soulmachines.com"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id","description":"An identifier for the user initiating the generation request."},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar","description":"The avatar look for the Digital Person. This will be used to choose the avatars look from a well known set of avatars. (default to '{DEFAULT_AVATAR}')","default":""},"style_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Style Id"},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id","description":"template to use as a base for the interaction","example":""},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"response_length":{"anyOf":[{"$ref":"#/components/schemas/ResponseLength"},{"type":"null"}],"default":"moderate"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"The timezone for the interaction, if specific timing is relevant (e.g., 'America/New_York').","default":"NONE"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"null"}],"description":"Optional direct webhook configuration to be called upon interaction completion, bypassing named triggers."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"timeout_secs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout Secs","description":"The timeout to wait for the interaction to be fully created in seconds, default is 20 seconds. Even if 0 seconds is given a valid URL is still returned that will wait for the interaction to be created as needed.","default":20},"ttl_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ttl Seconds","description":"Optional TTL in seconds for the interaction record. If 0 or negative, the record will not expire. If None, a default TTL will be applied."},"auth_settings":{"anyOf":[{"$ref":"#/components/schemas/AuthSettings"},{"type":"null"}],"description":"Optional authentication settings for the interaction. If not provided, the authentication settings from the template will be used."},"welcome_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Welcome Message","description":"An optional welcome message for the interaction. If not provided, the AI-generated welcome message will be used."},"topics_to_avoid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topics To Avoid","description":"An optional list of topics to avoid in the interaction. If provided, the agent will avoid these topics in the interaction."},"allowed_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Allowed Domains","description":"List of allowed origin URLs that can use this interaction (e.g., ['https://example.com', 'http://localhost:3000']). If None, no origin restrictions apply."}},"type":"object","required":["role","results","purpose"],"title":"GeneratorRequest","description":"Request body for the generator endpoint, detailing the desired interaction to be created."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InteractionState":{"type":"string","enum":["preparing","ready","failed"],"title":"InteractionState"},"InteractionSummary":{"properties":{"interaction_url":{"type":"string","title":"Interaction Url"},"web_apikey":{"type":"string","title":"Web Apikey","description":"Web API key for widget deployment, extracted separately from interaction URL for convenience"},"state":{"anyOf":[{"$ref":"#/components/schemas/InteractionState"},{"type":"null"}],"default":"ready"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"welcome_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Welcome Message"},"waiting_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waiting Message"},"warning_messages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Warning Messages"},"topics_to_avoid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topics To Avoid"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Id"},"interaction_id":{"type":"string","title":"Interaction Id"},"created_at":{"type":"string","title":"Created At"},"name":{"type":"string","title":"Name"},"avatar":{"type":"string","title":"Avatar"},"style_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Style Id"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expires At"},"created_by_key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Key Id"},"response_length":{"anyOf":[{"$ref":"#/components/schemas/ResponseLength"},{"type":"null"}],"default":"moderate"},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name"},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"deleted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deleted At"},"is_deleted":{"type":"boolean","title":"Is Deleted","default":false},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"tone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tone"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"NONE"},"seed_memory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seed Memory"},"behaviour_style":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behaviour Style"},"generative_gestures":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generative Gestures"},"conversation_start_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Start Prompt"},"auth_settings":{"anyOf":[{"$ref":"#/components/schemas/AuthSettings"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["interaction_url","web_apikey","interaction_id","created_at","name","avatar","expires_at"],"title":"InteractionSummary","description":"Response body for the summary and generator endpoints."},"OrgResponse":{"properties":{"organization_id":{"type":"string","title":"Organization Id"}},"type":"object","required":["organization_id"],"title":"OrgResponse"},"ResponseLength":{"type":"string","enum":["concise","moderate","detailed"],"title":"ResponseLength"},"Template":{"properties":{"template_name":{"type":"string","title":"Template Name"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"purpose":{"type":"string","title":"Purpose"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","default":{}},"objectives":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectives"},"auto_end_session":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto End Session"},"name":{"type":"string","title":"Name"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar"},"style_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Style Id"},"voice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice Id"},"created_by_key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Key Id"},"response_length":{"anyOf":[{"$ref":"#/components/schemas/ResponseLength"},{"type":"null"}],"default":"moderate"},"results":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Results"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","default":"Assistant"},"tone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tone","default":"friendly"},"context":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Context"},"knowledge_snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Knowledge Snippet"},"template_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Type"},"parent_template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Template Id"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]},"context_mapping":{"anyOf":[{"additionalProperties":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object"},"type":"object"},{"type":"null"}],"title":"Context Mapping"},"results_mapping":{"anyOf":[{"additionalProperties":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object"},"type":"object"},{"type":"null"}],"title":"Results Mapping"},"auth_settings":{"anyOf":[{"$ref":"#/components/schemas/AuthSettings"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"},"deleted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deleted At"},"is_deleted":{"type":"boolean","title":"Is Deleted","default":false},"welcome_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Welcome Message"},"topics_to_avoid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topics To Avoid"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"seed_memory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seed Memory"},"behaviour_style":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behaviour Style"},"generative_gestures":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generative Gestures"},"conversation_start_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Start Prompt"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"null"}]},"template_id":{"type":"string","title":"Template Id"},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Id"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"image":{"type":"string","title":"Image","readOnly":true}},"type":"object","required":["template_name","purpose","name","template_id","created_at","updated_at","image"],"title":"Template"},"TriggerCreate":{"properties":{"trigger_id":{"type":"string","title":"Trigger Id"},"webhook":{"$ref":"#/components/schemas/Webhook"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"}},"type":"object","required":["trigger_id","webhook"],"title":"TriggerCreate"},"TriggerId":{"properties":{"trigger_id":{"type":"string","title":"Trigger Id"}},"type":"object","required":["trigger_id"],"title":"TriggerId"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Webhook":{"properties":{"url":{"type":"string","title":"Url"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Method"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"body":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Body"}},"type":"object","required":["url"],"title":"Webhook"}}}}