Skip to main content
An API allows external systems to communicate directly with your agent through secure, programmatic endpoints. This channel enables integration of your VIVI agent into custom applications, backend systems, or third-party workflows using standard HTTP-based requests. When you create a new API channel, VIVI generates a unique set of credentials and documentation including a channel ID and API key. You’ll also receive auto-generated OpenAPI/Swagger documentation that details the available endpoints, request structures, and required parameters.

​
Endpoints

VIVI provides three primary endpoints for API-based communication:
NameMethodPathDescription
Stream MessagesPOST/channelsApi/{channelId}/streamStreams responses progressively in real time.
Invoke MessagesPOST/channelsApi/{channelId}/invokeSends a single message and returns a response.
Batch MessagesPOST/channelsApi/{channelId}/batchSends multiple messages in a single request.
A test button is next to each endpoint in the interface, allowing you to validate behavior once the API channel is linked to a published agent.

​
Best Practices

  • Keep your API key secret and rotate it if you suspect exposure.
  • Always test endpoints using the provided tools before connecting production systems.
⌘I