Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: FlashData Customer System API
version: 0.2.0-draft
summary: FlashData control-plane API contract
description: Google search, YouTube data and media downloads, with endpoints for jobs, accounts, API keys and billing. See /docs for request examples and setup guides.
contact:
name: FlashData Engineering
servers:
- url: https://api.flashdata.dev/v2
description: Management API
tags:
- name: System
paths:
/health:
get:
operationId: getHealth
tags:
- System
summary: Service health
security: []
responses:
'200':
description: Healthy
content:
application/json:
schema:
$ref: '#/components/schemas/Health'
/status:
get:
operationId: getPublicStatus
tags:
- System
summary: Read the public component status summary
security: []
responses:
'200':
description: Public status summary
headers:
Cache-Control:
$ref: '#/components/headers/CacheControlPublic'
content:
application/json:
schema:
$ref: '#/components/schemas/PublicStatus'
components:
headers:
CacheControlPublic:
description: Public cache duration and stale-response policy
schema:
type: string
const: public, max-age=60, stale-while-revalidate=300
schemas:
Health:
type: object
additionalProperties: false
required:
- status
- service
- version
- time
properties:
status:
type: string
enum:
- healthy
- degraded
service:
type: string
version:
type: string
time:
type: string
format: date-time
PublicStatusComponent:
type: object
additionalProperties: false
required:
- id
- name
- status
properties:
id:
type: string
name:
type: string
status:
type: string
enum:
- operational
- degraded
- outage
PublicStatus:
type: object
additionalProperties: false
required:
- status
- updatedAt
- components
properties:
status:
type: string
enum:
- healthy
- degraded
- outage
updatedAt:
type: string
format: date-time
components:
type: array
items:
$ref: '#/components/schemas/PublicStatusComponent'
securitySchemes:
dataApiKey:
type: apiKey
in: header
name: X-API-Key
description: FlashData API key. Job access is restricted to the key's source scopes.
agentRegistrationProof:
type: http
scheme: bearer
description: Persist a cryptographically random 32-byte base64url proof and exact request BEFORE sending; recover only with the same proof and body. Not an OAuth token.
cookieSession:
type: apiKey
in: cookie
name: __Host-fd_session
description: Opaque Web session. The browser cannot read this cookie.
agentSetupCredential:
type: http
scheme: bearer
description: Temporary setup credential for status and claim creation only. Not a data API key.
csrfToken:
type: apiKey
in: header
name: X-CSRF-Token
agentIdentityKey:
type: http
scheme: bearer
description: Ordinary FlashData API key in Authorization Bearer, only on agent identity. Data queries use X-API-Key instead.
agentHandoffProof:
type: http
scheme: bearer
description: Proof used to recover the owner key and acknowledge installation. Never sent to a data query.