Integrations
Create an integration
Connect a platform account to Ollive.
How it works
Ollive checks your keys with the platform before saving anything. If the platform rejects them, nothing is saved and you get a 422.
To see which type values and keys you can use, call List integration types. Once connected, Ollive reads the agents on that account, and List assets shows them.
Request body
application/json
- typestringrequired
The platform type, from List integration types. For example,
RETELL. - namestringup to 255 characters
A name for this connection. Defaults to the platform’s name. Must be unique in your account.
- keysobject
The keys the platform needs, as name and value pairs. Any URL must be a public
https://address.
Response
Connected. Secret keys are never returned, only whether they are set.
- idstring (uuid)required
The integration’s ID.
- typestringrequired
The platform type, such as
RETELL. - kindstringrequired
What kind of platform it is.
agent_platformagent_observabilityalert_and_workflow - namestringrequired
The name you gave it.
- keysobject[]required
The keys saved on this integration. Secret values are never shown, only whether they are set.
- namestringrequired
The key’s name.
- is_secretbooleanrequired
Whether the value is secret.
- is_setbooleanrequired
Whether a value is saved.
- valuestringrequired
The saved value. Always empty for secret keys.
- created_atstring (date-time)required
When it was connected.
- updated_atstring (date-time)required
When it was last changed.
- last_synced_atstring (date-time)
When Ollive last read the agents on this platform. Missing until the first read.
Something in the request is wrong. code and param tell you what.
Returns an error, for example with the code unknown_integration_type.
The API key is missing, wrong, revoked or expired.
Returns an error, for example with the code authentication_failed.
That name is already in use in your account.
Returns an error, for example with the code duplicate_name.
The platform rejected these keys. Nothing was saved.
Returns an error, for example with the code connection_test_failed.