API Limitations

This page describes the limitations of the Report Flow Content Service API.

tip

These limitations apply to the production environment (api.re-port-flow.com).

---

📦 Request Size Limit

Maximum Request Size: 50MB

The maximum request body size is 50MB (after Base64 encoding).

Effective file size estimate:
- Before Base64 encoding: ~37MB
- Encoding overhead: ~1.33x

tip

As a document output SaaS, we provide sufficient capacity to handle reports with large amounts of high-resolution images.

Behavior on Exceeding Limit

When request size exceeds 50MB:

{
  "statusCode": 413,
  "message": "Payload Too Large",
  "error": "Request Entity Too Large"
}

Handling Large Files

For large images or data, consider the following approaches:

1. Optimize Images

   • Reduce resolution (72-150dpi for web, 300dpi for print)
   • Adjust compression (JPEG quality 80-85% recommended)
   • Remove unnecessary metadata

2. Use Async Endpoints

   • For generating many PDFs, use async endpoints
   • Process large data without timeout concerns

3. Split Data

   • Divide requests when generating multiple PDFs in a single request

---

⏱️ Timeout Limits

Sync Endpoints: 120 seconds

Affected Endpoints:

• POST /v1/file/sync/single
• POST /v1/file/sync/multiple

A 120-second timeout is configured to handle complex document processing.

Timeout Response:

{
  "statusCode": 504,
  "message": "Gateway Timeout",
  "error": "Request timeout"
}

For processing exceeding 120 seconds:

• Use async endpoints (/async/single, /async/multiple)
• Reduce design complexity (fewer images, table rows)
• Split requests

Async Endpoints: No Limit

Affected Endpoints:

• POST /v1/file/async/single
• POST /v1/file/async/multiple

Async endpoints have no timeout limit. They're suitable for bulk PDF generation and complex design processing.

---

🚦 Rate Limit

Rate limiting has been implemented as of February 2024.

Workspace-based Limits

Rate limits are applied per workspace. Requests from the same workspace are counted together, without affecting other workspaces.

Endpoint Type	Limit	Target Endpoints
Sync Endpoints	30 requests/min	/sync/single, /sync/multiple
Async Endpoints	100 requests/min	/async/single, /async/multiple
Download & Retrieval	100 requests/min	/download/*, /design/parameter/*

Rate Limit Exceeded Response

When the rate limit is exceeded, the following response is returned:

{
  "statusCode": 429,
  "message": "Rate limit exceeded for this workspace. Please try again in XX seconds.",
  "error": "Too Many Requests"
}

Design Rationale

• Sync Endpoints (30 req/min): Considering the 120-second timeout, this allows up to 60 parallel processes, aligned with ECS task capacity.
• Async Endpoints (100 req/min): Supports batch processing and bulk generation. Protects server resources while maintaining high throughput.
• Download (100 req/min): Higher limit for lightweight operations.

tip

For normal UI operations (approximately 1 request every 2 seconds), you won't reach the limit. For batch processing, please use async endpoints.

---

📝 Filename Restrictions

Disallowed Characters

The following characters cannot be used in filenames:

Character	Name
/	Slash
\	Backslash
:	Colon
*	Asterisk
?	Question mark
"	Double quote
< >	Angle brackets
|	Pipe
Control chars	0x00–0x1F

All other characters (alphanumeric, Japanese, spaces, various symbols, etc.) are allowed.

Examples

✅ Valid:
{
  "fileName": "invoice_2024-01.pdf",
  "fileName": "report-2024-01.pdf",
  "fileName": "レポート (January).pdf",
  "fileName": "report #001.pdf"
}

❌ Invalid:
{
  "fileName": "invoice/2024.pdf",  // Slash not allowed
  "fileName": "data:2024.pdf",     // Colon not allowed
  "fileName": "report*.pdf"        // Asterisk not allowed
}

---

🔐 Security Requirements

HTTPS Required

The production environment only accepts HTTPS connections. HTTP requests are automatically redirected to HTTPS.

# ✅ Correct
curl -X POST https://api.re-port-flow.com/v1/file/sync/single \
  -H "appkey: your-app-key"

# ❌ Incorrect (HTTP not allowed)
curl -X POST http://api.re-port-flow.com/v1/file/sync/single

TLS Version

• Minimum version: TLS 1.2
• Recommended version: TLS 1.3
• TLS 1.0/1.1 are not supported

API Endpoint

Production:

URL: https://api.re-port-flow.com/v1/*

Staging:

URL: https://api.stg.re-port-flow.com/v1/*

Authentication Failure:

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Invalid credentials"
}

API Key Rotation

For improved security, we recommend regenerating your application key every 3 months.

See API Key Management for details.

---

📊 Plan Limits

Workspace plans have the following restrictions:

Design File Limit

Each plan has a maximum number of design files that can be created in a workspace.

File Generation Limit

Each plan has a monthly limit on PDF generation count.

info

Specific limits vary by plan. Check your current usage and limits in the admin dashboard.

Exceeding Plan Limits

When plan limits are reached:

{
  "statusCode": 403,
  "message": "Plan limit exceeded",
  "error": "Forbidden"
}

---

🌐 Network Restrictions

CloudFront Requests

External requests are processed via CloudFront:

Client → CloudFront → ALB → ECS (content-service)

---

📋 Additional Restrictions

Health Check Endpoint

The /v1/health/check endpoint is accessible without authentication. This endpoint is not logged in access logs.

CORS Configuration

The following headers are allowed:

• Origin
• X-Requested-With
• Content-Type
• Accept
• Authorization
• appkey

Requests from all origins (*) are accepted.

---

🆘 Handling Limit Exceeded Errors

Request Size Exceeded

1. Optimize images
2. Split data
3. Use async endpoints

Timeout

1. Use async endpoints (/async/single, /async/multiple)
2. Simplify design
3. Split requests

Plan Limit Exceeded

1. Upgrade plan in admin dashboard
2. Delete unnecessary design files
3. Adjust usage frequency

---

📞 Support

For questions or support regarding limitations:

• Email: [email protected]
• Admin Dashboard: https://re-port-flow.com/support

---

Changelog

Date	Changes
2026-02-15	Initial version