Browse documentation
Get started
Use the right host and credential, then verify access with one free request.
On this page
Base URLs
| Purpose | Base URL | Authentication |
|---|---|---|
| Data queries and jobs | https://data.flashdata.dev/v1 | X-API-Key |
| Identity, balance, pricing, limits and usage | https://api.flashdata.dev/v2 | X-API-Key |
| Remote MCP | https://data.flashdata.dev/mcp | Host-managed OAuth, or X-API-Key |
Authentication headers
REST requests use X-API-Key with a trial or owner key. Send JSON bodies with Content-Type: application/json. CLI profiles, SDK environments and MCP connections store credentials separately.
X-API-Key: fd_YOUR_API_KEY
Content-Type: application/jsonLet the MCP host obtain, store and refresh this token through login. Use it only at the MCP endpoint. Hosts using an API key instead send X-API-Key.
Authorization: Bearer YOUR_MCP_ACCESS_TOKENVerify your key
Run this in your terminal. The identity endpoint checks access without spending credits. Skip the key prompt if FLASHDATA_API_KEY is already set.
Requires Bash and cURL 7.76+. Skip the hidden key prompt if your environment already supplies FLASHDATA_API_KEY. Run the read commands in the same terminal.
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY(
: "${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}"
curl --fail-with-body --silent --show-error --max-time 20 \
--header "X-API-Key: $FLASHDATA_API_KEY" \
'https://api.flashdata.dev/v2/api-access/identity' || exit
printf '\n'
)Skip the hidden key prompt if FLASHDATA_API_KEY is already set. Run the read commands in the same terminal.
# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKey& {
$ErrorActionPreference = 'Stop'
if ([string]::IsNullOrWhiteSpace($env:FLASHDATA_API_KEY)) {
throw 'Set FLASHDATA_API_KEY first'
}
$flashdataHeaders = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY }
$flashdataBase = 'https://api.flashdata.dev/v2'
$flashdataUri = "$flashdataBase/api-access/identity"
Invoke-RestMethod -Uri $flashdataUri `
-Headers $flashdataHeaders -TimeoutSec 20 -MaximumRedirection 0 |
ConvertTo-Json -Depth 20
}Expected response
Expect HTTP 200. Check the intended account, access: ready and your source in scopes. A temporary key has accountType: temporary; recurring owner work requires recurringAllowed: true.
{
"accountId": "acc_example",
"apiKeyId": "key_example",
"accountType": "owned",
"access": "ready",
"scopes": [
"google_search"
],
"recurringAllowed": true
}Signed storage URLs
Result and upload URLs include their own authorization. Follow the returned URL without X-API-Key, OAuth tokens or browser cookies.
Troubleshooting authentication
| Response | Next step |
|---|---|
| 401 | Check the key in this environment, its expiry and revocation. Use a current API key, not an MCP token or a Bearer prefix. |
| 403 / source missing | Ask the owner to grant the required source to this key. |
| 503 on this free read | Retry the read later. Account status was not verified; do not infer that a paid query is ready. |