API Limitations
To ensure optimal performance, fair usage, and compliance with accreditation requirements, Woolf’s Airlock API includes several limitations. Understanding these limits will help you integrate and operate smoothly.
📈 Request Rate Limit
To prevent abuse and ensure system reliability, API usage is subject to a rate limit.
-
Limit:
50 requests per minute
per client. - Exceeding this limit will return a
429 Too Many Requests
response. - To avoid being throttled, implement rate-limiting or request queuing in your system.
🧠 GraphQL Query Depth Limit
To protect against overly complex or nested queries, the GraphQL API enforces a query depth limit.
-
Maximum Depth:
5
levels of nesting - Queries exceeding this will return a
413 Payload Too Large
error. - Design your queries efficiently to stay within depth limits and reduce load.
📂 File Upload Size Limit
The API supports file uploads for assets like documents, videos, and images.
-
Max File Size:
1 GB
- Uploads beyond this will return a
413 Payload Too Large
error. - Large videos should be compressed or streamed using HTTP Live Streaming (HLS).