Documentation

Overview

File API is a read-oriented HTTP API. All responses are JSON encoded in UTF-8.

Quick start

Every resource is reachable under https://media.badgereu.win/api/v1. No SDK is required.

Authentication

Requests carry a project key in the Authorization header. Keys are scoped per environment and may be rotated without downtime.

Errors

Errors return a JSON object with an error.code and error.message. The HTTP status carries the same meaning as the code.

Rate limits

Limits are applied per key. Exceeding a limit returns 429 with a Retry-After header.

Endpoints

MethodEndpointDescription
GET/api/v1Version index and resource map.
GET/api/v1/filesFiles stored under the current project.
GET/api/v1/typesContent types accepted on upload.
GET/api/v1/quotaStorage quota and current consumption.
GET/api/v1/limitsUpload size and rate limits.
GET/api/v1/statusMachine-readable service status.