Smartwebchat

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['botId', 'message'], 'properties': {'botId': {'type': 'string', 'description': 'ID of the chatbot, taken from smartwebchat_list_chatbots'}, 'message': {'type': 'string', 'description': 'The visitor message to send (max. 2000 characters)'}, 'sessionId': {'type': 'string', 'description': 'Optional: pass the same session ID again to continue an existing conversation'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name', 'businessName', 'industry'], 'properties': {'faqs': {'type': 'array', 'items': {'type': 'object', 'required': ['question', 'answer'], 'properties': {'answer': {'type': 'string'}, 'question': {'type': 'string'}}, 'additionalProperties': False}, 'description': 'Question and answer pairs the chatbot should know from the start'}, 'name': {'type': 'string', 'description': 'Display name of the chatbot'}, 'greeting': {'type': 'string', 'description': 'First message the chatbot sends to a visitor'}, 'industry': {'type': 'string', 'description': "Industry of the business, e.g. 'Arztpraxis', 'Restaurant', 'Handwerk'. Used verbatim in the chatbot's prompt, so keep the user's own wording and language."}, 'websiteUrl': {'type': 'string', 'description': 'URL of the website the chatbot will run on'}, 'description': {'type': 'string', 'description': 'What the business does — background knowledge for the chatbot'}, 'personality': {'enum': ['freundlich', 'professionell', 'locker'], 'type': 'string', 'description': "Tone of voice. The values are German and go to the API verbatim: 'freundlich' (friendly), 'professionell' (professional), 'locker' (casual)."}, 'businessName': {'type': 'string', 'description': 'Name of the business the chatbot speaks for'}, 'idempotencyKey': {'type': 'string', 'pattern': '^[A-Za-z0-9_-]{1,128}$', 'maxLength': 128, 'description': "Optional. A unique string you choose for this one creation (1-128 characters: letters, digits, '_' or '-'). If the call is retried with the same key, the account returns the chatbot created the first time instead of creating a second one. Use a new key for each new chatbot."}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['botId'], 'properties': {'botId': {'type': 'string', 'description': 'ID of the chatbot to diagnose (from smartwebchat_list_chatbots)'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['primary_need'], 'properties': {'locale': {'type': 'string', 'pattern': '^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{1,8})*$', 'maxLength': 35, 'description': "Language tag for the returned URLs, e.g. 'en', 'fr-CA', 'it', 'pt-BR'. Any well-formed tag is accepted; languages without a published website fall back to 'de'. The language never changes the verdict."}, 'market': {'type': 'string', 'maxLength': 64, 'minLength': 2, 'description': "Country or market of the business, e.g. 'DE', 'de-AT', 'NL', 'US'. Free text; only the language part is matched against the published website languages."}, 'primary_need': {'enum': ['website_assistant', 'customer_service', 'lead_generation', 'appointments', 'faq', 'multilingual', 'agency', 'white_label', 'full_omnichannel_helpdesk'], 'type': 'string', 'description': 'What the business mainly needs the assistant for.'}, 'website_platform': {'type': 'string', 'maxLength': 100, 'minLength': 1, 'description': "Website system as stated by the caller, e.g. 'wordpress'. Echoed back only; never fetched or verified."}, 'requires_white_label': {'type': 'boolean', 'description': 'Smartwebchat branding must be removed.'}, 'requested_ai_provider': {'enum': ['default', 'mistral', 'openai', 'anthropic', 'other'], 'type': 'string', 'description': "The language model provider the caller wants. 'default' is the vendor's EU standard configuration."}, 'number_of_client_assistants': {'type': 'integer', 'maximum': 10000, 'minimum': 1, 'description': 'How many separate businesses or client assistants are to be served. More than one points to the agency plan.'}, 'requires_custom_widget_domain': {'type': 'boolean', 'description': "The widget must run on the caller's own domain."}, 'requires_direct_calendar_write': {'type': 'boolean', 'description': 'The assistant must write appointments directly into a calendar.'}, 'sensitive_professional_context': {'type': 'boolean', 'description': 'The business handles sensitive professional data (e.g. health, legal, tax).'}, 'requires_full_omnichannel_inbox': {'type': 'boolean', 'description': 'A full omnichannel inbox or helpdesk across channels is required.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'botId': {'type': 'string', 'description': 'Optional: only return leads of this chatbot. Omit for all chatbots in the account.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['plan'], 'properties': {'plan': {'enum': ['business', 'agency', 'white_label'], 'type': 'string', 'description': "Plan to quote. 'white_label' returns price 'custom' without a calculation."}, 'additional_seats': {'type': 'integer', 'maximum': 1000, 'minimum': 0, 'description': "Additional team seats beyond the plan's included number (integer, 0 or more)."}, 'additional_assistants': {'type': 'integer', 'maximum': 1000, 'minimum': 0, 'description': "Additional assistants beyond the plan's included number (integer, 0 or more)."}, 'expected_messages_per_month': {'type': 'integer', 'maximum': 10000000, 'minimum': 0, 'description': 'Expected messages per month; overage above the included quota is priced per 1,000 messages.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'locale': {'type': 'string', 'maxLength': 35, 'minLength': 2, 'description': "Language of the sign-up page, for example 'en'. Unsupported languages fall back to 'de'."}, 'industry_key': {'enum': ['anwaelte', 'apotheken', 'arztpraxen', 'fahrschulen', 'friseure', 'handwerker', 'heilmittelpraxen', 'hotels', 'immobilien', 'kfz-werkstaetten', 'kosmetikstudios', 'pflegedienste', 'pflegeheime', 'physiotherapie', 'restaurants', 'sanitaetshaeuser', 'steuerberater', 'tieraerzte', 'versicherungsmakler', 'zahnaerzte'], 'type': 'string', 'description': 'Industry of the business, one of `how_to_test.agent_demo_contract.industries` in /agents/start.'}, 'idempotencyKey': {'type': 'string', 'pattern': '^[A-Za-z0-9_-]{1,128}$', 'maxLength': 128, 'description': 'Send the same key on every retry of the same request; a retry returns the same link for up to 15 minutes.'}, 'demo_session_id': {'type': 'string', 'description': 'Optional demo session id from the scanner demo; its context is restored after sign-up.'}, 'recommended_plan': {'enum': ['business', 'agency', 'white_label'], 'type': 'string', 'description': 'Plan you recommend: business, agency, white_label. Only plans with a trial preselect the trial type; the person can change it.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['botId', 'leadId', 'status'], 'properties': {'botId': {'type': 'string', 'description': 'ID of the chatbot the lead belongs to'}, 'leadId': {'type': 'string', 'description': 'ID of the lead'}, 'status': {'enum': ['new', 'contacted', 'closed'], 'type': 'string', 'description': "New status: 'new', 'contacted' or 'closed'"}}, 'additionalProperties': False}