Freeday API Documentation
Freeday API lets you connect your systems to our digital workforce — start conversations, exchange messages in real time, and export conversation data.
Where to start
-
REST API — authenticate, create and manage conversations and
cases, mint realtime tokens, and use the SDK endpoints on
https://api.freeday.ai. -
Realtime (AsyncAPI) — the WebSocket protocol for
receiving and sending live conversation messages on
wss://realtime.freeday.ai. - Conversation data export — the NDJSON events Freeday can write to your storage bucket, with a JSON Schema to validate them.
A typical integration
- Authenticate — see User authentication or, for machine-to-machine, Client credentials.
- Create a conversation with the SDK or conversation endpoints.
- Connect over WebSocket using a connection token, then subscribe to the conversation channel to stream messages.
- (Optional) Export conversation data to your bucket for analytics.
Getting access
All API calls require authentication. Contact the Freeday team to get credentials for your organization.