REST API

Before you start

• A business account
• A public HTTPS GET endpoint
• An API that accepts the q query parameter and returns JSON

Connect step by step

1. 1

   Check the query parameter

   Your API must accept the question as q. If it uses another parameter name, choose Custom HTTP and set that name there.

2. 2

   Enter the base endpoint

   Choose REST API and enter the search address. Add any credentials your service requires; Wayo supplies the customer’s question.

3. 3

   Test the response

   Wayo looks for common answer fields in the JSON, or uses the JSON itself. Confirm the result is helpful, add your offerings and reach, then connect.

Request & response

https://your-api.example/search?q=Do%20you%20deliver%20to%20Austin%3F

{
  "answer": "We deliver within 25 km of Austin."
}

Example addresses and IDs are placeholders. Replace them with your service’s values.

These examples connect an API directly. Using the SDK? See SDK return formats and when a signing secret is required.

Check that it works

The test can read the JSON response and show useful information from your service.