get started
Limits
How large a request can be, how long a call can take, how many calls you can make, and how to match a call to a record on your side.
Request and file size
| Limit | Value |
|---|---|
| A file sent in a request | 5000 MB (5,242,880,000 bytes) |
A whole multipart/form-data request | 5000 MB |
A Photoshop (.psd) file | 450 MB |
For a large file, send it to Upload Project Resource Content as the raw body, with Content-Type: application/octet-stream: it goes to storage as it arrives instead of being read as a form.
Timeouts
A call ends with 504 when the server takes more than 60 seconds to answer it once the request has been sent.
Work that takes longer than that is asynchronous: the call returns a job or request id at once and you poll its status, or receive a webhook when it ends. See Asynchronous operations and Webhooks.
Rate limits and concurrency
Keep your integration within these practices. Traffic outside them can be limited or blocked.
- Send up to about 10 requests in parallel.
- Retry a
5xxwith exponential backoff. - Reuse one token instead of authenticating before every call.
- Don't poll in a tight loop: use webhooks.
Matching calls to your records
Match calls to the records on your side with the ids the API returns:
- Store the
uuidthat each create call returns next to your own record id. - Put your own id in the project's
referencewhen you create it, so you can find the project in a list later. - Webhook requests carry
X-BWX-Event-ID, which retries keep. Store the ids you have handled; see Webhooks.