# Welcome 👋 ### What is Twise? [Twise](https://twise.ai/) is a human-like AI built to speak to your customers online. It learns from your content to sell, promote, pitch and support. It provides visually beautiful answers using images, videos and voice. While we put great effort into making Twise as easy to use as possible there will always be questions so we created this guide to help you out. You can always write us an email at [hello@twise.ai ](mailto:hello@twise.ai)as well. {% embed url="" %} # Quick start guide Creating a twise is easy. The very first time you sign up you will be presented with two options: 1. Create from website (recommended) 2. Create from scratch We suggest you try creating from your website which will: * Pull in the styles and the logo from your website. * Learn from the home page and the about page * Create somewhere between 50 to 100 knowledge cards based on the knowledge that he learns. * Create the right custom instructions for the AI to represent your company in the best way possible. We made a big effort to make this step as easy as humanly possible. In fact, you only need to add your website URL and Twise will do all the work for you. ### What's next - how to improve and make it production ready Once you're done with this initial setup, you can dive deeper into configuring your twise further. Which can include changing the design, adding a lot more content (including uploading documents, videos, audio files, images, etc.) Twise was built to also make it super simple for you to give your AI all the knowledge and information about you and your business. Explore [How twise learns from your content](/content/how-twise-learns-from-your-content) # \[Video] Beginners guide on how to edit and share a twise {% embed url="" %} # What is new? Last updated May, 2024. ### May 24 * Twise is now quite a bit faster * Response times are down to around 3 seconds most of the time * That is much faster than most text based website chatbots even * The website widget now has a welcome message * You can configure the message as well as if the browser title should change or not to alert the user that they can talk to the twise * [Learn more](/sharing/website-widget) * Customise the welcome card * You can change the colors and text for the welcome card (the popup that appears when the user starts the conversation) * That can be under Design > Welcome card * Further design customisation * We've added more design tweaks, including setting header text weight and link fonts and colours. * We've also added font preview in the dropdown boxes. * Go to DESIGN > Theme to change this * Custom voice management * You can now view and add custom voices * You can find this feature under your account (the avatar in the top right corner in the admin) ### May 9 * Knowledge card creation is better and faster * The creation of knowledge cards from documents, scrape a website, audio or video files is now faster * We've deployed new AI models to deal with this. Please let us know if you see any issues. * Leads are now captured on a separate page & email alert * If you turn on the leads function your twise will ask your visitors if they want to leave their email or phone number * That information is now shown on a separate lead list * Each time a lead comes in it will also be sent to you, as the owner of the twise, via email together with the conversation history * The Call To Action setting has moved to the Lead page * Activating the CTA will show a button at the top of your twise * Clicking the button will either open a form, or an external link * You can activate this setting on the Lead page * Design customisation * You can now change the font sizes and the text alignment. There is a new tutorial for this [here](/design/custom-design) * You can also toggle on/off all the other elements on the twise canvas, including the avatar and the hamburger menu. This is helpful when you are using the embed feature or the widget to not have one menu on your site and then another one inside the twise. * The input box, where the user types their message, can be switched to a dark version, which might match better your website design * All these features are found on the DESIGN tab * Open the widget from a custom button * If you use the website widget, where the twise opens in a layer above the page, you can hide the avatar and instead use any button or element on your page to open it * Any link or element on your page can be given a class which will open the widget * Learn more [here](/sharing/website-widget#use-any-link-or-button-on-your-site-to-open-the-widget) * Custom domains * We have enabled the option to host your domain which means that your twise can have its own domain * Please reach out to us if you're interested in activating this: * Videos and audio can now auto-play * A cool way to make your twise come alive is to have a video as your welcome visual * You can have the video auto-play as well as have it loop * These settings are avilable when you upload a new video ### April 30 * Design customisation * You can now change the visual aspect of a twise, including changing the fonts and the colours. * This can be found in the admin under the Design tab * Widget that can be embedded on your site * You have seen the widgets on websites everywhere where you click a little avatar or icon down in the right corner to open a chat bot * We have added a similar feature so your users can speak with your twise without leaving the page * Just copy a piece of code and add it to the webpage where you want it to show * [Learn more](/sharing/website-widget) * Lead capture * You can now have your twise ask your customers for their contact information if/when they show that they are interested. Their contact information will be added to a separate tab. * We will soon build out further functions for how you can get the email sent to you via email as well as have it pushed into other systems, like a CRM. * [Learn more](/other/lead-capturing) * Content import via XML or CSV * You can bulk upload content into your twise by uploading a list of links, or documents, using CSV and XML formats. * Speed and latency improvements * We have made many smaller changes to reduce the speed and latency. * We have been running promising trials with new language models that will drive down the latency even further although at the moment none of them are good enough to deliver the quality we need. # \[Video] Tips, tricks and admin walk through This guide walks you through a hands-on discussion about setting up and using Twise.ai, featuring tips and insights shared by René (Twise.ai) during a live walkthrough with a customer. {% embed url="" %} **1. Introduction to Twise.ai** • Overview of Twise.ai capabilities: • Provides instant, intelligent, and personalized responses for website visitors. • Allows businesses to train AI using existing website content, documents, and media. • Offers multilingual support, customizable design, and advanced visitor insights. • Goals of the discussion: • Addressing specific use cases for a safari business. • Learning best practices for training and using Twise.ai effectively. **2. Key Features Highlighted** Content Training: • Methods: Scraping website content, uploading documents (e.g., PDFs), and manual input. • Best practices: Use selective scraping or upload curated content to avoid irrelevant data. • Example: Customizing knowledge cards with sample safari itineraries. Custom AI Responses: • How to edit responses to ensure they reflect accurate and natural language. • Setting up clarifying questions before collecting visitor contact details. Style Customization: • Extracting website styles for seamless integration. • Customizing the AI’s welcome message and response tone. • Voice Options: • Choosing or uploading a custom voice for AI interactions.
**3. Advanced Setup Tips** Managing Content and Images: • Adding images to knowledge cards for visual context. • Associating images with specific answers. Cleaning Data: • How to delete outdated or irrelevant information. • Using the “delete conversation history” feature to refresh AI memory. Building Visitor Menus: • Automatically generating navigation menus for FAQs and topics. **4. Practical Use Cases Discussed** Handling Visitor Inquiries: • Example: Providing itineraries for Ethiopia safaris and tailoring responses based on uploaded content. Simplifying Lead Qualification: • Guiding visitors with clarifying questions. • Collecting contact details through conversational prompts. • Multi-Property Management: • Setting up separate AIs for different business URLs or combining them.
**5. Technical Insights** Embedding Twise.ai: • Instructions for adding widgets to websites (e.g., embedding code on Wix). • Sharing full-screen AI links for social media promotion. Using Third-Party Resources: • How Twise.ai interacts with embedded tools like Wetu for itinerary details. • Workarounds for inaccessible content (e.g., uploading itineraries as PDFs).
**6. Lessons Learned and Feedback** Importance of: • Curating content for accuracy and relevance. • Balancing automation with a human touch in customer interactions. Observations: • Small businesses can champion AI adoption to enhance customer engagement.
**7. Next Steps** Actionable Takeaways for Users: • Begin with curated content uploads and selective scraping. • Test and refine responses through preview mode and conversation insights. • Leverage Twise.ai’s full-screen links for broader engagement. • Pro Tip: Use visitor insights to refine offerings and target customer needs. **8. Additional Resources** Related Help Articles: • [Setting Up Twise.ai for the First Time.](/welcome/quick-start-guide) • [Managing Knowledge Cards and Responses.](/content/knowledge-cards) • [Tips for Optimizing Visitor Engagement](/other/understand-the-visitor-setting-up-twise-for-personalized-engagement).
This outline ensures the help article covers the critical points discussed in the video while providing actionable guidance for Twise.ai users. # How twise learns from your content Adding knowledge is a fundamental aspect of making your twise useful. All twises are created to limit the answers to the context they are given which comes from the knowledge, the content, you add. By limiting the answers to its given knowledge we avoid what is often called "hallucinations", where the AI simply makes things up trying to answer as best it can. Twise does not make things up. Instead it will say that it doesn't have the answer and make a polite statement. It will also add the user's question to the list of Unanswered questions that you can find under the [Insights](/other/insights) tab. ### What happens when you upload a document? Most AI tools, including ChatGPT, will use your original document to inform the AI. This leads to the black hole problem, where it's hard to know exactly from where the AI sources its answer, especially if you add multiple larger documents. To solve for this issue we convert all uploaded documents that contain text into [knowledge cards](/content/knowledge-cards), which are basically a set of questions and answers that twise thinks your customers and users are likely to want to ask. We use AI pre-processing of all documents to convert them into the cards which gives you visibility into exactly what the AI knows, and you can quickly find those cards and edit them, making sure twise always provides the right answer. # Knowledge cards When you upload content that contains text, or can be transcribed into text, twise will use AI to extract a list of questions and answers from that content, and convert it into content cards. Here is an example of a LinkedIn profile being converted into cards:

Knowledge cards

The cards can be found under the **Content > Knowledge tab.** You can search for cards that contain a specific word or phrase, and then edit or delete the card. ### Why the Question and Answer format? You will see that the two fields for any card is Question and Answer. While you do not have to follow this format the first field will tell the AI when to use the content that is in the answer field. So field one, Question, acts like an instruction to the AI for when to use this specific knowledge. Since twise is all about answering users questions fast and accurately it makes sense to structure the knowledge in a question and answer way but again you can use the Question field to give other instructions too, like adding a general concept, for example "Pricing" and then in the Answer field you type out the pricing information. ### How do I add new knowledge cards? Any documents added through the Learn from documents tab will automatically create knowledge cards.\ \ ![](/files/gNylt7fCZmC6i51VDMnu) You can also quickly add new cards by clicking:\ ![](/files/0hxvpqqvfVkhlOB5vRTw) or click the Quick add option:
### Best practise for adding knowledge cards First off, do not add too much text into a card, if you create one manually. The cards should ideally be in a Question and Answer format with one question and one answer per question. For the best quality output do not add more than 100-200 words. For longer documents, or longer questions and answers, please upload them as a word or text document under the Add content > Learn from documents tab. # Best practise for adding content Your twise can learn from a website, through scraping, or through uploading of documents or even by transcribing an audio or video file. The uploaded text will be converted into [knowledge cards ](/content/knowledge-cards)so you can edit and tweak as needed. Having said that it is important to not overwhelm your twise with content as it will get harder and harder to control the answers. ### Start small and add more over time First of all we recommend that you start small and expand from there. That means that instead of scraping a full website just add one page, or that you upload a single document first and then continue adding more. Observe the knowledge cards that are being created once you upload a document so that you get a general idea about the learning process. # Understanding how twise works with your content ### Overview Twise is designed to transform the way you interact with and present your content. Unlike traditional websites or platforms where every piece of content is displayed and indexed in its entirety, Twise intelligently selects the most relevant snippets or sections of your content to answer user questions. This ensures that your AI-driven answers are precise, accurate, and highly relevant, without being overwhelmed by the volume of data. ### How we process your content When you upload your content to Twise, it doesn’t use every single word verbatim. Instead, the AI analyzes your material and creates knowledge cards. These knowledge cards are then used to inform the AI, and often multiple such cards (or snippets) will be used to inform the AI, to give it context. This approach allows Twise to manage large amounts of content effectively, ensuring that only the most relevant parts are used to generate responses. Here’s how it works: 1\. Content Analysis: Twise scans your uploaded content and knowledge cards to understand its context and structure. 2\. Snippet Selection: Based on user queries, Twise identifies and extracts the most relevant snippets from your content. 3\. Response Generation: Using these snippets, Twise constructs accurate and contextually appropriate answers for your users. ### Best practises for uploading content While Twise can handle large volumes of content, we recommend an iterative and structured approach to uploading your material for optimal performance: 1\. Segment Your Content: Instead of uploading an entire website, book, or extensive document at once, break your content into smaller, manageable sections. This could be by topic, chapter, or any other logical division that suits your material. 2\. Iterative Uploads and Testing: Upload your content piece by piece and test how Twise responds to different questions. This iterative process helps you fine-tune the content and ensure that Twise is accurately selecting the most relevant snippets. 3\. Monitor and Adjust: Regularly review the answers generated by Twise. If necessary, adjust your content or the way it is uploaded to improve the quality and relevance of the responses. ### Example workflow 1\. Start Small: Upload a few sections or chapters of your content. 2\. Test Queries: Ask Twise various questions related to the uploaded content to see how it responds. 3\. Analyze Responses: Check the relevance and accuracy of the answers provided by Twise. 4\. Refine Content: Make any necessary adjustments to your content or the structure of your uploads. 5\. Repeat: Continue uploading more content in segments, testing, and refining as needed. # How to match answers with visuals Twise will only be able to find images or visuals, videos etc, that have clear descriptions and/or instructions for when they should be shown.

See the instructions field

A trick is to place the exact question that a user might have inside the Instructions box so that the Ai can find it. You can also add a description, for example: *An image of a website widget.* ### How can you make sure that some images are not shown? Or avoid them being shared at the wrong place? Try updating the Instructions field to either something very specific that will avoid it being show for more general queries. Example: if you have an image of a house the more specific you are in the instruction the clearer the AI will understand when to show it and when not. Avoid generic instructions such as: an image of a person Instead try: An image of a young man, holding a sign, that illustrates how product helps # Include links in answers Your twise can display links as part of an answer and it will display those in the same way as it displays any other written content. A link could be to an internal link on your site, or external, like a form. It will open in a new tab. Here is how: 1. Create a new [knowledge card](/content/knowledge-cards) 2. Write the question as you normally would 3. As part of the written answer just paste in the link you want it to show as such:
# What kind of content can be uploaded? You can upload both text documents as well as images and videos. In most cases you can also use the content inside the document, such as the audio from a video, to extract the content into [knowledge cards](/content/knowledge-cards). ### What are the max file sizes? 5 MB for images, 100 MB for videos, 10 MB for audios, 20 MB for documents ### Accepted file types * Text * Word * PDF * ePub * TXT * Media * Audio in MP3 format * Video in MP4 format * YouTube * Vimeo * Soundcloud * Images (jpg, jpeg, gif, webm, gif, png) # Video and audio files Twise can display, and play, audio and video files directly as part of an answer. ### How to upload a video or audio files Go to the admin and then pick then CONTENT tab. Pick the Images, video or audio option. **Size limits:** 5 MB for images, 100 MB for videos, 10 MB for audios
### Convert the audio content into knowledge cards When uploading a video, or audio file, you can choose to convert the content into knowledge cards and also decide if you want the media file to show up in the canvas, or only use it to extract the content.
# Adding lists and structured content When working with lists and structured content, such as a document listing all the restaurants in the Vegan category, Twise can transform this information into a dynamic question-and-answer format. Here's how it works and what you need to consider: **Understanding Semantic Search**: Unlike traditional categorical searches that rely on predefined categories and exact matches, Twise uses semantic search to understand the context and meaning behind queries. This allows users to ask more natural questions and receive relevant answers. **Transforming Content**: When you upload structured content into Twise, we convert it into a format that supports semantic search. For example, if you have a list of Vegan restaurants, each entry is enriched with contextual information. Questions could range from “Where is the best Vegan restaurant in downtown?” to “What Vegan options are available in this neighborhood?” The answers will be drawn from the content you provide, including details like location, category, and specific features of each restaurant. **Thinking Differently About Uploads**: Since Twise relies on semantic understanding, the way you structure your data impacts its effectiveness. Here are some tips: 1. **Comprehensive Descriptions**: Ensure each entry includes detailed descriptions. For restaurants, include not just the name and address, but also highlights like menu specialties, ambiance, and customer reviews. 2. **Contextual Information in the Body**: All relevant details should be included in the body of each entry. For instance, for Vegan restaurants, include prices, addresses, web pages, phone numbers, and specific location details. Repeating the name of the restaurant or entity within the body helps Twise accurately identify and retrieve information. 3. **Repetition for Clarity**: Repeating the name of the place, person, or company within the content ensures clarity. This repetition helps Twise link the information correctly, making it easier to answer queries precisely. **Benefits**: By uploading well-structured and comprehensive data, Twise can deliver more accurate and intuitive responses to user queries. This makes the information more accessible and useful, enhancing the overall user experience. In summary, when adding lists and structured content to Twise, aim for detailed and context-rich entries, ensuring all relevant information is included in the body. This maximizes the power of semantic search and provides the best possible answers to user questions. # The basics of how knowledge retrieval works **Categorical Search**: This traditional method uses predefined categories and keywords to find information. It's simple but limited to exact matches. **Semantic Search with Twise**: When you upload your structured data (like a people or product database) into Twise, it converts this data into a question-and-answer format using advanced techniques. Semantic search understands the context and meaning behind queries, not just exact words. **RAG (Retrieval-Augmented Generation)**: Twise combines finding relevant data (semantic search) with generating accurate responses. When users ask questions, Twise retrieves the most relevant information and generates precise answers. **Benefits**: This makes your data more accessible and user-friendly, providing accurate and intuitive responses to user queries. **Things to Consider**: Semantic search may not always find every answer within a specific category, especially if the data is sparse or not well-defined. It’s important to ensure your data is comprehensive and well-organized to maximize the effectiveness of Twise's semantic capabilities. # Bulk import content via CSV or XML file You can quickly import content into a twise by using the XML/CSV option, You can find this by clicking CONTENT > Knowledge > Add content > Import from file: \ ![](/files/NRRNKxFIZYTd5a2UwSHi) ### Before you get started It is important that you understand how the AI will use your information to answer questions from the users before you get started. The most important thing is to not upload too much information as you start out. It is better to start small, with a few texts, or a single webpage, and then expand from there. Also consider that the kind of knowledge database that we use is unstructured so it doesn't work well for grouped or content that is in categories. This has to do with the way AI uses semantic search and not a classic database search. Read more [here](/content/the-basics-of-how-knowledge-retrieval-works). ### What can you import? * **Short text files** * The total body and additional information is a max of 50-150 words * Use the CSV file template no 1 * **Longer text files** * If you are looking to import more complex information like articles, blog posts, essays etc you can use the template no 2 which will pre-process the information and convert it into questions and answers. See [knowledge cards.](/content/knowledge-cards) * Please note that longer files with a lot of content in each body will generate tens to hundreds of knowledge cards. * **Images, audio & videos** * You can import images or videos using template no 3 * This requires a public link for each image, audio or video file * **Scrape website pages** * You can also scrape a single or multiple urls * Use the template no 4 for that * If you also want to scrape images set the field extract\_images to 1 * You can limit to scrape one page, or up to 10 pages by setting the field page\_limit to the number of pages you want to scrape ### General preparation for text documents When you import text into twise we only consider two fields: 1. **Question (labelled "description" in import):** This can either be a question or a title, or even just a product or service name 2. **Answer (labelled "text\_content")**: All your content goes here, including text and any additional info for example a phone number, a link, price information etc. The basic rule is that you will need to put all the content into the test\_content field in your CSV file and add a title, or question in the description field that indicates that the answer can be found in the answer. We have a [Google Sheet file here](https://docs.google.com/spreadsheets/d/1ZTPTlmXuE5OZd4Finqt9SVaHVcuY9jBEz9UDTMAfN9c/edit?usp=sharing) where you can see the examples. ### Sample CSV files {% file src="/files/lQKqjinf7cgAKFXblBjX" %} {% file src="/files/PWFpmfV4JRvskqx5Evst" %} {% file src="/files/o0OAu0OvxQIh01Mu2EcR" %} {% file src="/files/xvOoTKurr1CNffbibzrp" %} # What are collections? Imagine one of the following cases: * you own an online shop, and want to add your product assortment to a Twise * you rent/sell properties, and would want to add your listings to a Twise * you are a event listing site (tours, concerts, experiences, etc.), and want to add events to a Twise To support such cases, you can import a special kind of content we call a collection. A Twise will intelligently include your products in the conversation when it is relevant. Using collections, a Twise can transform into a product discovery tool using natural language. Currently, we support the following collection types: * `Product` * `Event` * `Villa` * `Page` A Twise currently is limited to use one collection type at a time. #### How to add content to a collection? * Using an API * [Adding events](/collections-api-events) * Importing a Google Merchant XML Feed * [Importing a Twise XML Feed](/importing-a-collection-via-a-twise-xml-feed) # Collections API - Events You’ll need to first obtain an API key using [instructions here.](/other/api-guide#api-key-management) #### Authentication For all endpoints, when making API requests, add the following auth headers: ``` Twise-Auth-Provider: cli Twise-Auth-Payload: {“token”:””} ``` ## Uploading events **Endpoint** `POST https://api3.twise.ai/personalities/{twise_id}/twin/vector_documents` (tip: you can find the twise\_id in Integrations -> Zapier -> Twise ID) **Request payload fields** This endpoint consumes application/json. | Field | Type | Required | Description | | -------------- | ------------ | -------- | ------------------------------- | | document\_type | boolean | Yes | Should be ‘event’ | | document | Event object | Yes | ‘Event’ object documented below | **Event model** | Field | Type | Required | Description | | -------------- | ----------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | If not provided, will automatically generate one. | | title | string | Yes | Event title | | description | string | Yes | Event description | | venue | string | No | Venue name | | url | string | No | URL for event details page | | phone\_number | string (in E.164 format) | No | Contact phone number (in E.164 format) | | contact\_email | string | No | Contact email | | address | string | No | Address | | city | string | No | City (e.g. “Dubai”) | | category | string | No | Category | | date\_start | ISO date string | No | When the event happens/starts. | | date\_end | ISO date string | No |

When the event ends.


date\_end cannot be defined if date\_start is not defined

| | price | string (decimal) | No |

Event ticket price (e.g. “100.50”).


Has to be provided together with currency.

| | currency | string (ISO 4217, 3-letter currency code) | No |

ISO 4217, 3-letter currency code (e.g. “AED”).


Has to be provided together with price.

| | media | List\[string] | No | List of URLs pointing to event images | | price\_range | PriceRange | No | A price range for tickets an event. If provided, product cards will show a price range instead of the price provided in `price`and `currency`fields. | #### Request body example ```json { "document_type": "event", "document": { "id": "event-id-2458", "title": "Desert Safari Adventure with Dinner", "description": "Experience the thrill of dune bashing in a 4x4 vehicle across the golden sands of the Arabian desert. This 6-hour adventure includes camel riding, sandboarding, and a traditional BBQ dinner under the stars with live entertainment featuring belly dancing and tanoura shows. Capture stunning sunset photos and get a henna tattoo as a souvenir of your desert experience.", "venue": "Arabian Desert Adventures", "url": "https://desertsafari.ae/evening-adventure", "phone_number": "+97155987654", "contact_email": "bookings@desertsafari.ae", "address": "Pickup from any hotel in Dubai", "city": "Dubai", "category": "Outdoor Adventures", "date_start": "2024-06-15T00:00:00", "date_end": "2025-09-30T00:00:00", "price": "199.0", "currency": "AED", "price_range": { "min_variant_price": { "amount": "199.0", "currency_code": "AED" }, "max_variant_price": { "amount": "349.0", "currency_code": "AED" } }, "media": [ "https://example.com/images/desert-safari-sunset.jpg", "https://example.com/images/desert-safari-dinner.jpg" ] } } ``` **Response Example** ```json { "_id": "67bc6c89e02d505067148ad5", "type": "event", "document_id": "event-id-2458", "document": { "id": "event-id-2458", "title": "Desert Safari Adventure with Dinner", "description": "Experience the thrill of dune bashing in a 4x4 vehicle across the golden sands of the Arabian desert. This 6-hour adventure includes camel riding, sandboarding, and a traditional BBQ dinner under the stars with live entertainment featuring belly dancing and tanoura shows. Capture stunning sunset photos and get a henna tattoo as a souvenir of your desert experience.", "venue": "Arabian Desert Adventures", "url": "https://desertsafari.ae/evening-adventure", "phone_number": "+97155987654", "contact_email": "bookings@desertsafari.ae", "address": "Pickup from any hotel in Dubai", "city": "Dubai", "category": "Outdoor Adventures", "date_start": "2024-06-15T00:00:00", "date_end": "2025-09-30T00:00:00", "price": "199.0", "currency": "AED", "price_range": { "min_variant_price": { "amount": "199.0", "currency_code": "AED" }, "max_variant_price": { "amount": "349.0", "currency_code": "AED" } }, "media": [ "https://example.com/images/desert-safari-sunset.jpg", "https://example.com/images/desert-safari-dinner.jpg" ], "display_price": "199.0 AED", "price_float": 199.0 }, "personality_id": "67ab4c6df78156bf40dc813e", "id_suffix": "148ad5", "updated_at": "2025-02-24T12:56:41.028000Z", "uploaded_at": "2025-02-24T12:56:41.028000Z", "twin_feed_sync_id": null } ``` ## Get events **Endpoint** `GET https://api3.twise.ai/personalities/{twise_id}/twin/vector_documents` (tip: you can find the twise\_id in Integrations -> Zapier -> Twise ID) **Request URL params fields** | Field | Type | Required | Description | | -------------- | ------- | -------- | ----------------------------------- | | document\_type | string | Yes | ‘event’ | | per\_page | int | No | number of events to return per page | | is\_featured | boolean | No | gets only ‘featured’ events | | sort | string | No | key to sort by: ‘updated\_at’ | **Response Example** ```json { "total_count": 114, "next_page": 2, "prev_page": null, "results": [ { ... }, ] } ``` ## Update events **Endpoint** `PUT https://api3.twise.ai/personalities/{twise_id}/twin/vector_documents/{_id}` (tip: you can find the twise\_id in Integrations -> Zapier -> Twise ID) **Request payload fields** This endpoint consumes application/json. | Field | Type | Required | Description | | -------- | ------------ | -------- | ------------------------------- | | document | Event object | Yes | ‘Event’ object documented below | | Field | Type | Required | Description | | -------------- | ----------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | | title | string | No | Event title | | description | string | No | Event description | | venue | string | No | Venue name | | url | string | No | URL for event details page | | phone\_number | string (in E.164 format) | No | Contact phone number (in E.164 format) | | contact\_email | string | No | Contact email | | address | string | No | Address | | city | string | No | City (e.g. “Dubai”) | | category | string | No | Category | | date\_start | ISO date string | No | When the event happens/starts. | | date\_end | ISO date string | No |

When the event ends.


date\_end cannot be defined if date\_start is not defined

| | price | string (decimal) | No |

Event ticket price (e.g. “100.50”).


Has to be provided together with currency.

| | currency | string (ISO 4217, 3-letter currency code) | No |

ISO 4217, 3-letter currency code (e.g. “AED”).


Has to be provided together with price.

| | media | List\[string] | No | List of URLs pointing to event images | **Request body example** ```json { "document": { "city": "Abu Dhabi", "address": "Pickup from any hotel in Abu Dhabi" } } ``` **Response example** ```json { "_id": "67bc6c89e02d505067148ad5", "type": "event", "document_id": "event-id-2458", "document": { "id": "event-id-2458", "title": "Desert Safari Adventure with Dinner", "description": "Experience the thrill of dune bashing in a 4x4 vehicle across the golden sands of the Arabian desert. This 6-hour adventure includes camel riding, sandboarding, and a traditional BBQ dinner under the stars with live entertainment featuring belly dancing and tanoura shows. Capture stunning sunset photos and get a henna tattoo as a souvenir of your desert experience.", "venue": "Arabian Desert Adventures", "url": "https://desertsafari.ae/evening-adventure", "phone_number": "+97155987654", "contact_email": "bookings@desertsafari.ae", "address": "Pickup from any hotel in Abu Dhabi", "city": "Abu Dhabi", "category": "Outdoor Adventures", "date_start": "2024-06-15T00:00:00", "date_end": "2025-09-30T00:00:00", "price": "199.0", "currency": "AED", "price_range": { "min_variant_price": { "amount": "199.0", "currency_code": "AED" }, "max_variant_price": { "amount": "349.0", "currency_code": "AED" } }, "media": [ "https://example.com/images/desert-safari-sunset.jpg", "https://example.com/images/desert-safari-dinner.jpg" ], "display_price": "199.0 AED", "price_float": 199.0 }, "personality_id": "67ab4c6df78156bf40dc813e", "id_suffix": "148ad5", "updated_at": "2025-02-24T13:32:40.081000Z", "uploaded_at": "2025-02-24T12:56:41.028000Z", "twin_feed_sync_id": null } ``` ## Delete events #### **Endpoint** `DELETE https://api3.twise.ai/personalities/{twise_id}/twin/vector_documents/{_id}` (tip: you can find the twise\_id in Integrations -> Zapier -> Twise ID) Returns 204 No Content on a successful deletion. ### **Delete events (batch)** You are also able to batch delete documents using: `DELETE https://api3.twise.ai/personalities/{twise_id}/twin/vector_documents` **Usage example** ```sh curl --location --request DELETE 'https://api3.twise.ai/personalities/{twise_id}/twin/documents' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' \ --header 'Content-Type: application/json' \ --data '{ "ids": ["67ab248f6ec29515563aec51"] }' ``` **Response example** ```json { "success": true, "num_deleted": 1, "errors": [] } ``` # \[Video tutorial] How to get twise onto your website {% embed url="" %} # How to share a twise Twise can be shared wherever you customers are, either as link via email or social media, or as part of your website, as an [embed](/sharing/embed-onto-your-site) (iframe) or as a [widget](/sharing/website-widget) that opens up. ### Send a direct link You can send customers a direct link to a twise by coping the link which can be found in the admin where you edit your twise.
# Website widget ## Use your twise as a better looking chat bot alternative You can now add a widget to your website that will open in an overlay:
### Welcome message for the widget You can configure a welcome message that will appear next to the widget upon load. This message can be changed to anything you like. Use the text \[YOUR TWISE NAME] to insert the name of the twise automatically. You can change the colors of the text and the background as well.
### Widget customisation You can change the width and height of the actual overlay that opens when someone click the widget. That is done by updating the actual code: ``` var WIDTH = "1600px"; var HEIGHT = "900px"; ``` ### Alert user to speak to the widget The widget can be set to alert the user by changing the page title. This is a common practise for chatbots but can also be a distraction. ![](/files/lxLVdk5qMIMnGGJKp4qx) ### How to install the widget To be able to add the widget to your website you will need to be able to have acces to the code. We offer a javascript code that needs to be added inside the \ tag of the entire site or on the specific pages where you want the widet to appear. The code can be found under SHARING in the admin and then under Install Twise Widget:
### Use any link or button on your site to open the widget Assuming you have access to the code of your site, and know a little code, you can show the widget through a click on any button or link on your page. **Activate Hide avatar:**
Add this attribute to any HTML element where you want to activate the Twise widget. For instance, add `` to a button element to enable users to open the widget directly through this button. # Embed onto your site

Example of a twise seemlessly embedded

Twise can be embedded onto a site either as a full page or as part of the content using an iFrame. To copy the embed code go to the Sharing tab in the admin or look for it under the Sharing button in the top right corner.
# Access rights You can restrict who can access you twise by going to SHARING -> GENERAL -> VISIBILITY Access can be restricted on three different levels: * **Public**: This means that anyone with the link can interact with your twise * **Organization**: Access will be restricted to users that are logged in and are part of your organization * **Private**: This means that only you, and any users that are logged in and part of the collaborators list can access.
### Collaborators access rights There are three levels of collaboration rights:
* **Viewer**: Can interact, like a normal user would, even if the Visibility is set to Private. They will need to have an active twise account and be logged in. * **Editor**: Can add, edit and delete content. They will also need to have an account and be logged in. * **Owner**: Will have the same access rights as the creator of the twise. # Understand the Visitor: Setting Up Twise for Personalized Engagement This guide will help you configure your AI assistant to effectively engage visitors, collect valuable information, and provide a seamless user experience tailored to your business needs. ### 1. Crafting Your Welcome Message The welcome message is the first interaction visitors will have with your AI assistant. By making it a question, you can immediately guide the conversation and set the tone. For example: • Example 1: “Hello and welcome! What brings you here today?” • Example 2: “Welcome! Are you looking for travel advice, booking options, or inspiration?” • Example 3: “Hi there! What language would you like to communicate in?”
This approach encourages visitors to share their needs right away and helps Twise personalize its responses. ### 2. Adding Conversation Starters Conversation starters are quick, clickable options that guide visitors and provide structure to their interaction. These can be tailored to your business goals, such as gathering specific insights or speeding up the inquiry process. For instance: **Travel Industry Example:** • “I’m traveling alone.” • “I’m looking for family trips.” • “Tell me about budget-friendly options.” **Retail/E-commerce Example:** • “Show me trending products.” • “Help me find a gift.” • “I need product recommendations.” **Language/Preference Example:** • “Let’s talk in English.” • “I prefer Spanish.” • “Switch to French.” ### How To Change The Welcome Message and/or Conversation Starters You can find the welcome message and conversations starters under BASICS - WELCOME:\ \ ![](/files/xTpUL6NgUe73zUZPLNGI)
### 3. Configure the Communication Style Twise allows you to define how it interacts with visitors by creating a structured list of questions that guide the conversation. Here’s an example setup: "When engaging visitors, follow these steps: 1\. Ask: “What’s your destination?” 2\. Ask: “What’s your budget?” 3\. Ask: “Are you traveling alone or with others?” 4\. Confirm details like name, contact info, and preferences. 5\. Suggest relevant solutions based on their input." This approach ensures Twise collects the information you need while maintaining a natural conversation flow. ### How To Change The Communication Style Go to BASIC SETUP - COMMUNICATION STYLE:
\
### Best Practices • Keep your welcome message short and engaging. • Use conversation starters to guide visitors and offer immediate value. • Regularly update your communication style to reflect common visitor needs and preferences. • Test and iterate: Review insights from Twise to refine your questions and suggested topics. Make sure to [reset the conversation](/other/how-to-iterate-and-improve-answer-quality) when you are testing. # Lead capturing ### Capture leads through natural conversation Twise is capable of capturing leads by asking the user if they wish to leave their contact details. It will do so after the user has indicated interest. To activate this feature go to the LEADS tab and toggle Capture leads on.![](/files/aUygFC8BGED41LPh1sTl) Please note that it will be the AI that determines when to ask the user for their contact details. ### What contact data is captured? Twise will ask for the user to leave their email and or phone details. This will depend on the conversation as twise aims to capture the relevant data depending on the users needs. ### Lead list
You can find the list of captured data under the Leads tab as a table. ### Email alert Once a lead comes in the owner of the twise receives an email that contains the conversation history.
### Integrations **Can this data be sent to other systems?** This is under development. For now the data can only be accessed under the Leads tab. # Contact form & CTA Twise can display a button at the top that can either open a contact form or link to an external page. The standard button says "Contact Us" and this can be customised to any text.

See the button at the top right corner.

### What information is captured in the form? ### ![](/files/CLqvsxE6ZO8ZPjtUln8e) The form asks for the users email and allows them to add a message. ### How will I be notified? When the user submits a form you will get an email similar to the one you receive if you have the lead function enabled. It contains the full conversation history. ### How do I activate the form? To activate the form go to LEADS > Setup
You can change the button text as well as add a custom url. ### Make the button link to another page By adding a custom url you can link the button to any external site. The link will open in a new window. # Insights Twise provides detailed insights into what your users have been asking about, it extracts keywords, sentiments and a list of questions asked. You can also see the unanswered questions which is a great way to keep on improving the answer quality. ### Unanswered questions We suggest that you copy the unanswered question and use that to create a new [knowledge card ](/content/knowledge-cards)by clicking the icon that looks like a speech bubble with a plus inside it. You can also mark a question as answered by clicking the two check marks (this will remove the question from the list).
#### Conversation history for unanswered questions By clicking the time icon you can open the full conversation history and see the full context of what the user was asking about that could not be answered.
### Screenshots

General usage statistics

Keywords, sentiments and questions, including unanswered questions

# Voices ### Voice models Twise comes with two different voice models, BASIC and ADVANCED. The main difference between the voices are the quality, where the advanced does usually sound much more human-like and warm. The other important difference is the pricing. Due to the cost the advanced model required twice as many message credits as the basic model. ### How to change voice In the admin, go to BASICS - SETUP and then scroll down to find the voice selection:

The advanced voices has pre-listening activated. The basic ones does not.

### Languages All voices speak all languages. Some will sound better that others and we recommend you trying out different models. You can start with the basic and switch to the advanced ones if needed/preferred. Please note that even though the voices have been trained to have a spefic accent when they speak English, like American, British or Indian, all voices can speak other languages too, and the accent will not be reflected. ### Voice cloning Twise also allows for you to clone your voice. To do so follow the steps: 1. [Login](https://app.twise.ai/admin) to the dashboard 2. Click on your avatar in the top right corner 3. Click on VOICES 4. Add new voice by uploading audio files and giving it a name **File format and size** Please note that you can only use MP3 files, or Wav files for cloning your voice and files can be max 10MB. ### Where can you find your cloned voice? It can be found under the voice list, where you edit the voices for any twise. Look under ADVANCED voices. It will be available right after you go through the cloning process. ### # Privacy and security At Twise, we understand that privacy and security are top concerns for our users. Here’s how we ensure that your data remains secure and private, addressing the most common concerns: **Privacy Assurance**: We guarantee that none of your data will ever be used to train any AI models outside of your specific Twise instance. Your data is completely confined to answering questions from users interacting with your Twise setup. This ensures that your information stays within your control and is not shared or utilized for any other purposes. **Robust Security Measures**: Twise operates on Microsoft Azure, the same infrastructure trusted by many of the world’s most security-sensitive companies and governments. Azure provides state-of-the-art security features, including advanced threat protection, encryption, and compliance with global standards. We have implemented rigorous measures to protect your information, ensuring that your data is safe and secure at all times. **Recommendation**: While Twise is built with robust security and privacy measures, we strongly recommend not using Twise for private or sensitive data. Twise is designed to interact with customers online and is ideal for public data, such as the information on your website. This approach ensures that the data shared is appropriate for the public domain and maximizes the benefits of Twise’s capabilities. By focusing on public data and leveraging our strong security framework, you can confidently use Twise to enhance customer interactions without compromising on privacy or security. # Zapier Integration You can connect your twise with [Zapier](https://zapier.com/workflows) to enable automations with thousands of other apps. Twises currently support the following features: * Capturing new leads (e.g. push to a CRM) * Creating new twise knowledge cards (e.g. when you publish a new blog post, it can automatically be added to your Twise’s knowledge base) ### API Key You will need an API key to authenticate on your behalf on Zapier. Save your API key in a secure place as you will only see it once when generated. Generating a new API key will invalidate an existing key in case one exists. In case you have multiple Twises, you can re-use the same API key across multiple Zaps. You can generate an API key in your twise Settings page (Edit twise -> Integrations -> Zapier). ### How to make a new [Zap](https://zapier.com/workflows) to capture leads First, we connect your twise to Zapier and create the new Zap: In the Twise app: 1. Create a new twise. 2. Enable lead capturing in twise settings (Edit twise -> Leads -> Setup -> ‘Capture leads’ ON -> Click ‘Save’). 3. In ‘Edit twise -> Integrations -> Zapier’, generate a new API key (if you have not created one already). Save it for later. In the Zapier [home page](https://zapier.com/app/zaps): 1. click on ‘+ Create -> New Zap’. 2. Click on ‘1. Trigger’, and choose the ‘Twise’ app. 3. In ‘App & Event -> Event’, choose ‘New Lead’. 4. In ‘Account’, connect your Twise account via an API key. 5. In ‘Trigger’, choose the twise you want to capture leads from the list. 6. In ‘Test’, test the trigger, which should return a sample response of a captured lead. Next, we want to connect this trigger to an action, meaning we define what happens when a twise captures a new lead. As an example action, we’ll be recording new leads to a Zapier Table: 1. Go to the [Zapier Tables page](https://tables.zapier.com/app/tables) in a new tab. 2. Create a new blank table. Back in the new Zap page: 1. Click on ‘2. Action’, choose ‘Zapier Tables’ 2. In ‘App & event -> Event’, choose ‘Create Record’. 3. In ‘Action -> Table ID’, choose the newly created table. 4. For each table field, you can choose what Lead field to populate it with (e.g. Field 1 - Email, Field 2 - Phone, etc.). 5. In ‘Test’, you can test that sample data does indeed get added to the table. 6. Click ‘Publish’. If the Zap activates successfully, you should see the switch go ‘On’ on top-left. 7. Open a conversation with your twise, and write a message like ‘My email is .’ If everything connected smoothly, you now should see that new lead be added to a Zapier Table. ### How to make a new [Zap](https://zapier.com/workflows) to create twise knowledge cards In this example, we’ll connect to a BBC News feed, so that we can create new knowledge cards whenever the BBC publishes a new story. First, we connect your twise to Zapier and create the new Zap: In the Twise app: 1. Create a new twise. 2. In ‘Edit twise -> Integrations -> Zapier’, generate a new API key (if you have not created one already). Save it for later. In the Zapier [home page](https://zapier.com/app/zaps): 1. Click on ‘+ Create -> New Zap’. 2. Click on ‘1. Trigger’, and choose ‘RSS by Zapier’. 3. In ‘App & Event -> Event’, choose ‘New Item in Feed’. 4. In ‘Trigger -> Feed URL’, paste the BBC news feed URL: “”. 5. In ‘Test’, test the trigger, which should return a sample response of a BBC news story. Next, we want to connect this trigger to an action, meaning we define what happens when BBC publishes a news story. 6. Click on ‘2. Action’, choose the ‘Twise’ app. 7. In ‘App & event -> Event’, choose ‘Create Knowledge Card’. 8. In ‘Account’, connect your Twise account via an API key. 9. In ‘Action’, choose the twise you want to create new knowledge cards in. * For ‘Question’, choose the ‘Title’ field from the sample feed response. * For ‘Answer’, choose the ‘Description’ field from the sample feed response. 10. In ‘Test’, test the action, which should create a sample knowledge card in your twise. In the Twise app, you can now check the newly added sample card by going to ‘Edit twise -> Content -> Knowledge’. Now, whenever BBC publishes a news story, your twise will know about it. # How to iterate and improve answer quality As you test your twise you are likely to keep on adding more content, through new knowledge cards, as well as adding tweaking the instructions by adding or removing instructions from the communication style field.

This field is found under Basics & Setup when you edit a twise.

Adding custom instructions in this field can help you in many ways: * Instruct it to not pronounce specific characters, like $ and instead say the full word *"dollars"* * Clarify how a specific word is pronounced * Change the tone of voice: "You are funny and will often tell a joke" * Give it specific instructions: "Ask clarifying questions before you provide an answer" It's worth testing different prompts to see how it impacts the outcome. ### Reset the conversation history & reload to see changes reflected As you speak to twise it will always consider the past conversation history and that will greatly influence the output. As you tweak the communication style or add more content you must reset the conversation as well as reload the page to see the changes reflected. To reset the conversation history follow these steps: 1. Make sure you are logged in to Twise and that are the creator or admin of the twise you want to reset 2. Open the twise as you do when you talk and interact with it 3. Open the hamburger menu 4. Click the Delete Conversation History button\ ![](/files/Ww6zbcsZQgZOIO9HQtGd) 5. Reload the page The above process will let you test different settings in the best way possible. #### Alternative approach - incognito mode Open the twise in a new browser or in a new incognito window. Please note that Chrome seems to also remember the past conversations from multiple different incognito sessions. ### Resetting conversations also deletes them from the conversation history Please note that after resetting questions will not be visible in the insights or be registered as past conversations. # How do I upgrade to a paid plan? 1. If you do not have an account with Twise yet sign up [here](https://app.twise.ai/signup)\ **Please note** that the user that signs up will be the owner of the organisation, and the billing group, and can invite more members which will also be able to create twises as part of this billing group 2. Once you have signed up, or if you have an account already, go to your BILLING page, by clicking the avatar in the top right corner, and then BILLING\ ![](/files/kK73eKSoW18QxadJprXF) 3. Choose the plan that you suits you. We have three different plans at the moment, from Starter to Enterprise. 4. Add your billing details - we use [Stripe](https://help.twise.ai/other/www.stripe.com) as a payment processor and we do not store your billing details. 5. Done! # How do credits work and what happens if you run out? ### Understanding message credits Each interaction between a user and a twise instance requires a message credit. Depending on the voice model being used, some interactions may require two message credits per message. Each twise plan includes a set number of message credits, which are shared across all the twise instances under that plan. This means that a single plan's credits are distributed among all its twise instances. ### Managing message credits **Alerts for low message credits** When your message credits are running low, the admin of the account will receive an email alert. Additionally, there will be a notification in the admin dashboard indicating that you are about to run out of credits. **Adding more message credits** At present, adding additional message credits is a manual process. There is no auto-billing or automatic upgrade option available. To add more credits, you will need to contact the Twise team () who will assist you in replenishing your message credits. ### What happens if you run out of credits? When a twise runs out of credits, it will still be visible and accessible. However, the input bar where users type or speak their requests will become invisible. This means users can only interact with the twise through any navigation items under the menu or the initial three suggested responses on the welcome page. Additionally, as an admin, you will not be able to update the content or make any changes to any of your twises if the account has no more credits. For any further assistance or to add more message credits, please reach out to the Twise support team (). # Delete a twise To delete a twise go to EDIT > BASICS > SETUP and scroll down to find the ADVANCED SETTINGS which you will need to expand. In that section there is this option:
# API Guide Training Your AI with Knowledge Cards and Content Integration ### Introduction Twise transforms uploaded content into Knowledge Cards, enabling advanced Retrieval-Augmented Generation (RAG). These cards are highly controllable units of knowledge that your AI can utilize to answer questions, provide context, and deliver personalized outputs. By uploading content such as PDFs, images, text, or videos, you can train Twise to provide accurate, relevant, and visually engaging responses. Each piece of uploaded content becomes a foundational part of your AI’s “brain,” enhancing its ability to serve your website visitors seamlessly. This guide explains how to interact with Twise’s API, including generating an API key, authenticating requests, and leveraging endpoints for uploading and managing content. ### Before you get started You will need to have created an account with Twise as well as be on the paid Enterprise plan * Sign up for an account here: using the email address that will own billing * Start the paid Enterprise plan here: using a credit card ### API Key Management #### Generating an API key To make requests to the Twise API, you’ll need an API key. Follow these steps to generate one: 1\. Create a test Twise instance in the /admin page: • Use the ‘Create from Website’ or ‘New from Scratch’ options. 2\. Navigate to Settings of your Twise instance: • Go to Edit Twise -> Integrations -> Zapier. • Generate and save your API key. ⚠️ Important: Save your API key securely as it will only be shown once. Generating a new key will invalidate the existing one. ### Authentication When making API requests, include the following authentication headers: ``` Twise-Auth-Provider: cli Twise-Auth-Payload: {“token”:””} ``` ### Creating new content #### Endpoint ``` POST https://api3.twise.ai/personalities/{twise_id}/twin/documents ``` You can find the twise\_id in Integrations -> Zapier -> Twise ID. #### Request payload fields This endpoint consumes multipart/form-data. All form fields should be provided accordingly. At least one of document\_file, text\_content, or url must be provided.
FieldTypeRequiredDescriptionExample value
is_publicbooleanYesShould be true. Indicates whether a document is going to be retrievable by the twise.true
descriptionstringNo

Text describing the nature of the document.


For images, ‘description’ field determines the relevance of the document to the answer.

How to Win at Chess
document_filefileNoThe file to upload (PDF, image, text file, etc.). If not provided, text_content or url should be provided.@”/how-to-win-at-chess.pdf”
text_contentstringNoRaw text content of the document. If not provided, document_file or url should be used.
urlstrNoURL pointing to a Youtube resource. If not provided, document_file or text_content should be used.https://www.youtube.com/watch?v=dQw4w9WgXcQ
is_downloadablebooleanNoSpecifies whether the document is going to be displayed as part of an answer (e.g. in case of images). Defaults to falsefalse
extract_textboolNoIf true, extracts text content from the uploaded document. Defaults to false.true
extract_answersboolNoIf true, generates knowledge cards (question-answer pairs) from the document text. Defaults to false.true
extract_imagesboolNo(Only for html documents) If true, will extract images from the html file. Defaults to false.false
split_into_slidesboolNo(Only for PDF files) If true, will extract every PDF page as an image. Defaults to false.false
describe_slidesboolNo(Only for PDF files) If true, generates a description for each extracted image from each PDF page. Defaults to false.false
**Response example** ``` { "_id": "67593c803df3039e26c15fa6", "id_suffix": "c15fa6", "personality_id": "67593b4fd2c0e595c08b575c", # twise id document belongs to "content_type": "application/pdf", "size": 75435, "is_public": true, "is_downloadable": false, "display_options": { "autoplay": false, "mute": false, "loop": false, "hide_controls": false }, "uploaded_at": "2024-12-11T07:17:20.936000+00:00", "description": "Assignment 2", "text_content": null, "url": null, "twin_crawl_id": null, "source_document_id": null, "filename": "Assignment 2_CSCI115.pdf", "blob_name": "67593b4fd2c0e595c08b575c/Assignment 2_CSCI115.pdf", "extract_answers": true, "download_url": "", "source_document": null, "metadata": null, "indexing": { # document indexing status "status": "submitted", "num_batches": null, "processed_batches_count": 0 } } ``` **Usage example - c**reating a knowledge card You can think of a [knowledge card ](/content/knowledge-cards)as the core way the AI will source its answers. The knowledge cards are question and answer pairs which upon creation can also be edited through the admin. The knowledge card can be a simple answer to a question but it can also contain all the information about for example a product, like the price, location and a link to learn more. ``` curl --location 'http://localhost:8001/personalities//twin/documents' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' \ --form 'description="What is the name of our planet?"' \ --form 'text_content="Earth"' --form 'is_public="true"' \ --form 'is_downloadable="false"' \ ``` This creates a knowledge card, a question and answer pair for the Twise to use. **Note**: with all the examples here, you can see new content appearing in Edit Twise -> Content -> Knowledge/Media pages. ### Updating content **Endpoint** ``` PUT https://api3.twise.ai/personalities/{twise_id}/twin/documents/{document_id} ``` **Request payload fields** This endpoint consumes multipart/form-data. All form fields should be provided accordingly. At least one of document\_file, text\_content, or url must be provided. | Field | Type | Required | Description | Example Value | | ---------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | is\_public | boolean | No | Indicates whether a document is going to be retrievable by the twise. | true | | description | string | No |

Text describing the nature of the document.


For images, ‘description’ field determines the relevance of the document to the answer.

| How to Win at Chess | | document\_file | file | No | The file to upload (PDF, image, text file, etc.). | @”/how-to-win-at-chess.pdf” | | text\_content | string | No | Raw text content of the document. |


| | url | str | No | URL for a resource. | | | is\_downloadable | boolean | No | Specifies whether the document is going to be displayed as part of an answer (e.g. in case of images). Defaults to false | false | **Response example** ``` { "personality_id": "6757ec1ff471b684b0df0a43", "content_type": "text/plain", "size": 4, "is_public": true, "is_downloadable": false, "display_options": { "autoplay": false, "mute": false, "loop": false, "hide_controls": false }, "uploaded_at": "2024-12-10T07:24:02.149000Z", "description": "What year is it now?", "text_content": "2025", "url": null, "twin_crawl_id": null, "source_document_id": "6757ec2df471b684b0df0a45", "_id": "6757ec92f471b684b0df0b9f", "id_suffix": "df0b9f", "filename": null, "blob_name": null, "extract_answers": false, "download_url": null, "source_document": null, "metadata": null, "indexing": { "status": "submitted", "num_batches": null, "processed_batches_count": 0 } } ``` #### Usage Examples **Updating knowledge card content:** ``` curl --location --request PUT 'https://api3.twise.ai/personalities//twin/documents/' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' \ --form 'text_content="2025"' \ --form 'description="What year is it now?"' ``` ### Deleting content **Endpoint** ``` DELETE https://api3.twise.ai/personalities/{twise_id}/twin/documents/{document_id} ``` Returns 204 No Content on a successful deletion. \ **Usage example** ``` curl --location --request DELETE 'https://api3.twise.ai/personalities//twin/documents/' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' ``` ### Batch delete documents You are also able to batch delete documents using: ``` DELETE https://api3.twise.ai/personalities/{twise_id}/twin/documents ``` **Usage example** ``` curl --location --request DELETE 'https://api3.twise.ai/personalities/{twise_id}/twin/documents' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' \ --header 'Content-Type: application/json' \ --data '{ "ids": ["6757ec92f471b684b0df0b9f"] }' ``` \ **Response example** ``` { "success": true, "num_deleted": 1, "errors": [] } ``` ### Adding images Images works like other documents and can be updated or deleted in the same way as knowledge cards. **Example request:** ``` curl --location 'https://api3.twise.ai///twin/documents' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' \ --form 'description="Rick Astley - Never Gonna Give You Up"' \ --form 'is_public="true"' \ --form 'is_downloadable="true"' \ --form 'url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"' \ --form 'extract_answers="false"' \ --form 'extract_text="false"' ``` The YouTube video is going to be displayed as part of a Twise answer when relevant. If extract\_text is true, the audio transcript from the YT video is going to be stored as context. If extract\_answers is true, the audio transcript from the video is converted into knowledge cards. #### Uploading a PDF: ``` curl --location 'https://api3.twise.ai/personalities//twin/documents' \ --header 'Twise-Auth-Provider: cli' \ --header 'Twise-Auth-Payload: {"token":"sk_xxx"}' \ --form 'document_file=@"/how-to-win-at-chess.pdf"' \ --form 'description="How to Win At Chess"' \ --form 'is_public="true"' \ --form 'is_downloadable="false"' \ --form 'extract_answers="true"' ``` # Enterprise plan onboarding ### Introduction We’re excited to help you set up your AI concierge and ensure it effectively represents your company, products, and services. To do this quickly and efficiently, we need some key information from you. This will help us: 1. Add the necessary content to train the AI to provide accurate and helpful answers. 2. Understand the areas of your business you want the AI to focus on, so it can best assist your visitors. 3. Customize the AI’s behavior to align with your lead qualification process, ensuring it asks the right questions and captures important details. ### Billing information and invoices Please go to our Stripe powered [portal](https://billing.stripe.com/p/login/00g17pals9lK5aw000) where you can add your invoicing details and download invoices etc. ### What We Need from You: 1. Content: Details about your website content and any additional resources for training the AI. 2. Key Questions: A list of the top 10-20 questions you’d like the AI to answer, either from your FAQ or common inquiries. 3. Lead Qualification: Specific questions the AI should ask visitors, such as what they are looking for, budget, timelines, and other relevant details. Providing this information will allow us to tailor the AI to your needs and ensure it engages effectively with your visitors. #### Lead Qualification Think of this as giving instructions to a human assistant. The AI concierge needs clear guidance on how to qualify your leads effectively. Here’s what we need from you: 1. Lead Questions:\ What questions should the AI ask visitors to understand their needs? Examples include: 1. What are they looking for? 2. What is their budget? 3. What are their timelines?
2. Capturing Details:\ Specify when the AI should capture important visitor information, such as: 1. Email addresses 2. Phone numbers
3. Meeting Booking Forms:\ Let us know if/ when the AI should show a booking form. Currently, we only support Calendly for direct booking, so please provide your Calendly link if applicable.
4. Desired Flow:\ Describe how you envision the lead qualification process working.\ It doesn’t have to be a fully developed logic flow—we can collaborate to design the process based on your desired outcomes. This approach ensures that the AI captures the right information at the right time, helping you engage qualified leads and streamline the next steps. \ Content Preparation To train your AI concierge effectively, we need access to all relevant content. This includes: * Website Content: Text, images, and any other materials from your site. * Please list all the pages you want us to train on, or if more relevant, list the ones you do not want us to train on * Multimedia Resources: Links to YouTube videos or any video content available online. * Documents: PDFs, text documents, or any internal resources you’d like the AI to learn from. * Images and Videos: Any visual content that helps explain your products or services. Please package this information into a shareable resource (like a WeTransfer link) for easy access. #### Content Prioritization: Since the AI cannot be trained on everything from day one, it’s crucial to list your content in order of importance. Start with the most urgent and impactful materials and work down to less critical content. This ensures we focus on what matters most to your business right away.
# How to add a menu & navigation Your twise has a sidebar with settings, but can also have a sidebar navigation, or menu, that will help the user find more information and get quick access to specific answers or content. The answers that appear when users click any navigation item will appear super fast with no delay since we cache those answers once you stop editing your twise and 15 minutes has passed.

With sidebar navigation items - the title is then Explore

With no navigation items

### How does the navigation items work? Essentially they work like user inputs that will query the AI to respond. The items could be anything, from something simple like *About Us* to a more complex query like: *Who are the people behind this project?* You can add any text you want to the navigation by clicking the New Item button. ### Create a navigation using AI Twise can also create the navigation for you. You can have it create a FAQ (Frequently Asked Questions) where it will look through all your uploaded information and try to detect what some common question users might have. You can also create topics which will look more like a conventional navigation, so not in a question format. In both cases the AI will aim to read all the content and create the navigation for you.

The admin interface where you create the navigation

Once the AI is done creating the navigation for you it will appear on this same page. Please note that this can take several minutes.

FAQ navigation has been created automatically

Navigation with all the options - see the title changes to Explore

### Show the navigation on start If you toggle on this option the navigation sidebar will always be visible, on desktop, upon load.
### Doesn't seem to work? If no navigation appears this might be due to your twise having too much content so it can't be processed due to context window limitations. We will expand this as the AI models get more capable. # Custom design ### Change the visual design You can change the colours, fonts, font sizes and text alignment by going to the DESIGN tab in the admin. ### Hide other elements, like the navigation You can also hide the avatar, the hamburger menu and even the welcome card. All these settings can be found under the design page. Hiding the navigation can be useful if you embed the twise into another webpage, perhaps as a section, where the page already has a navigation.
See how it works in this interactive tutorial. {% embed url="" %}