Connect Aiva to your own systems
Describe the requests your own API accepts, and Aiva uses them in conversations to read a customer’s account or complete a request on the customer’s behalf.
Define each action Aiva may take
Give each action its method, path and parameters, and a description that tells Aiva when to call the action. For a verified customer, Assistify fills in the customer’s email, so Aiva reads only that customer’s account.
Questions about Custom API
What can the Custom API connect to?
Any REST API reachable from the internet. Authentication can be an API key in a header, a bearer token or basic authentication, and each action sends a GET, POST, PUT, PATCH or DELETE request.
Can Aiva change data through my API?
Yes, when you define an action that changes data. Aiva calls only the actions you define, and every request other than GET carries an idempotency key, so a retried request is not applied twice.
How does Aiva know which customer’s account to read?
For an action open to verified customers, Assistify fills the parameter you choose with the customer’s verified email. Aiva never chooses or sees that value.
What does Aiva see of a response?
The response, trimmed: lists to their first 50 items, long texts shortened, and fields such as avatars and download links left out.
Which plans include the Custom API?
Every plan. Aiva calls your actions on the plans that include Aiva. The plan comparison has the details.