Skip to main content
Both the File API and the Adclear API authenticate with the same bearer key. Every request needs two headers.

​
Required headers

HeaderRequiredDescription
AuthorizationYesBearer <your-api-key>, provided during onboarding
X-External-User-IDYesA stable identifier for the acting user in your system, such as an employee ID
X-External-User-EmailNoThe acting user’s email, when you have it
The API key is scoped to a single Adclear organisation and workspace. Rate limits apply per key (see Errors & rate limits).

​
Environments

EnvironmentFile APIAdclear APIPurpose
Staginghttps://files-staging.adclear.aihttps://public-api-staging.adclear.aiIntegration testing with sandbox data
Productionhttps://files.adclear.aihttps://public-api.adclear.aiLive
API keys are environment-specific. A staging key won’t authenticate against production, and vice versa.
Build and test your integration against staging before switching to production.

​
Interactive API reference

Explore and try endpoints in Swagger UI: Machine-readable OpenAPI 3.1 specs:
  • GET https://public-api.adclear.ai/v1/openapi.json
  • GET https://files.adclear.ai/v1/openapi.json

​
Generate types from the spec

Generate TypeScript types directly from the specs with openapi-typescript: 
npx openapi-typescript https://public-api.adclear.ai/v1/openapi.json -o adclear-api.d.ts
npx openapi-typescript https://files.adclear.ai/v1/openapi.json -o adclear-files.d.ts