Menu

Documentation

Authentication

Every request to the FlowData API carries a key in the Authorization header.

Bearer key

Create a key in the dashboard under API keys. It starts with fd_ and is shown only once. Send it with every request:

Authorization: Bearer fd_YOUR_KEY
Send the key only in the header, never in the URL. URLs end up in server and proxy logs.

What a key can reach

A FlowData key reaches all FlowData areas of the team it was issued for, and nothing else. You can give it an expiry date and a monthly spending limit.

Older keys

FlowSuite keys (pk_..., at_...) keep working in the five data areas with no end date and answer there with a Deprecation header. The Media API does not accept them and answers with HTTP 403, so it needs a FlowData key. We recommend switching for the data areas as well.

Error responses

HTTPMeaning
401Missing or invalid key
402The account cannot cover the request (insufficient_quota) or the spending limit has been reached (spend_limit_exceeded)
403The key may not use this area, or the account is suspended (billing_suspended)
429Too many requests. Media jobs also report missing funds here (insufficient_quota, spend_limit_exceeded)

Rate limits

Media endpoints allow 600 requests and 60 new jobs per minute and key. Exceeding them answers 429 with Retry-After.

One key is all it takes to start.

Create a key and call the API. Client info is free; everything else is billed per successful request.

Create an API key Documentation

FlowData is aimed exclusively at businesses and self-employed professionals.