API Facts
A one-page reference to the key facts about the Re:port Flow API. Values are kept consistent with each detail page (the primary source); for the binding content, follow the link in the "Source" column. If figures ever conflict, the primary source prevails.
Service facts such as pricing, data handling, and cancellation are consolidated on the landing page: Service Facts (EN) / サービス事実表 (JA). This page covers only API-specific facts.
Basics
| Item | Value | Source |
|---|---|---|
| Base URL | https://api.re-port-flow.com/v1 | Authentication |
| API version | v1 (in the path) | Authentication |
| Protocol | HTTPS only (HTTP redirects to HTTPS); minimum TLS 1.2, TLS 1.3 recommended | Limitations |
| Data format | Input: JSON (mapped to template variables); Output: PDF | PDF generation |
| Health check | GET /v1/health/check (no auth, not logged) | Limitations |
| Data residency | AWS Tokyo region (Asia Pacific (Tokyo), ap-northeast-1), within Japan | Service Facts |
Authentication
| Method | Use case | Source |
|---|---|---|
appkey header | Single-workspace automation (cURL, internal batch jobs) | API keys |
| OAuth 2.0 Client Credentials | Server-to-server integration (backend → Re:port Flow) | OAuth 2.0 |
| OAuth 2.0 Authorization Code + PKCE | Per-user authorization (Make.com, external SaaS, personal apps, MCP) | OAuth 2.0 |
For the full list of OAuth scopes (openid / profile / designs:read / designs:write / templates:read / templates:write / pdf:generate) and how to request them, see OAuth 2.0 as the primary source. Rotating API keys every 3 months is recommended.
Endpoints
| Endpoint | Method | Purpose | Source |
|---|---|---|---|
/file/sync/single | POST | Generate a single PDF synchronously | Sync single |
/file/sync/multiple | POST | Generate multiple PDFs synchronously (ZIP) | Sync multiple |
/file/async/single | POST | Generate a single PDF asynchronously | Async single |
/file/async/multiple | POST | Generate multiple PDFs asynchronously | Async multiple |
/file/download/{requestId} | GET | Download generated output (per request) | Download |
/file/download/{requestId}/{fileId} | GET | Download an individual file | Download |
/file/design/parameter/{designId} | GET | Get a design's parameter schema | Design parameters |
/file/designs | GET | List designs (paginated; for MCP/discovery) | Design parameters |
The authoritative, complete endpoint list and schemas are defined in the OpenAPI specification (openapi/content-service.yaml). This table is a summary of the main endpoints.
Limits (rate limits, size, timeouts)
| Item | Value | Source |
|---|---|---|
| Rate limit (sync) | 30 requests/min per workspace (/sync/*) | Limitations |
| Rate limit (async) | 100 requests/min per workspace (/async/*) | Limitations |
| Rate limit (download / fetch) | 100 requests/min per workspace (/download/*, /design/parameter/*, /designs) | Limitations |
| On exceed | 429 Too Many Requests + Retry-After header (RFC 9110 §10.2.3) | Limitations |
| Max request size | 50MB (after Base64 encoding, ~37MB effective) | Limitations |
| Timeout (sync) | 120 seconds (/sync/*) | Limitations |
| Timeout (async) | None | Limitations |
The authoritative values and behavior for rate limits, size, and timeouts are in Limitations. This table is a summary.
Samples (reproducible)
| Sample | What it verifies | Source |
|---|---|---|
| Invoice (English) | Alphanumeric display / currency with 2 decimals / line-item array | Examples |
| Invoice / Quotation / Worker roster / NDA, etc. | Multiple line items, tax calc, dates, long clauses | Examples |
Each sample publishes its input JSON, execution examples (curl / Node.js / Python), and a verified output PDF at GitHub: reportflow-examples (API version v1).