Flow Docs
Open Flow AI

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

Flow AI authenticates with API keys. Create one in Settings → Connect with Claude (company admins only) and give it a name. The full key is shown only once when you create it — copy it then. Each key starts with a flow_live_ prefix; keep it secret and never expose it in client-side code or public repos. You can revoke a key at any time.

Settings → Connect with Claude: the MCP endpoint, a config snippet, and the API keys table with a Create key button
Create and manage API keys under Settings → Connect with Claude. The same keys power the MCP connection.

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.

⌘I