API
The Flow AI REST API lets you read and write data from your own apps. Use it to sync with your CRM, build custom dashboards, or automate workflows.
Overview
The API uses standard HTTP and JSON. You send requests to our base URL and include an API key (or other auth) in the request. Responses return JSON. Typical use cases include fetching connections or lists, updating a connection status, or pulling analytics for a time range.
Authentication
You need to authenticate each request. Flow AI uses API keys (or the equivalent) that you create in your account or workspace settings. Include the key in the request header as specified in the API docs. Keep keys secret and do not expose them in client-side code or public repos.
Base URL and versioning
All requests go to the Flow AI API base URL. Endpoints are versioned so we can improve the API without breaking your integration. Check the latest API reference in the app or from support for the current base URL and supported versions.
Related
Webhooks push events to you when something happens. The API is for on-demand read and write. Use both together if you want real-time events plus custom queries and updates.