Forma: Takeoff API Rate Limits

The Forma Takeoff API observes a set of rate limits to ensure that all clients get sufficient service and that runaway applications don’t consume excessive resources. You’ll find general information about rate limits in APS Rate Limits and Quotas.

Rate Limits

The Takeoff service applies two different rate limits to Takeoff API requests. In general:

• All endpoints that read data (such as GET v1/projects/:projectId/packages) are limited to 300 requests per minute.
• All endpoints that create, update, or delete data (such as POST v1/projects/:projectId/packages are limited to 50 requests per minute.

These rate limits determine the number of requests the Takeoff service can accept per user account (specified in a 3-legged token).

Note that this rate is not a service guarantee. In the uncommon case where total service use is too high across all clients, the accepted request rate might drop until traffic subsides.

Data-Reading Endpoints

This rate limit applies to all endpoints that read data.

• GET v1/projects/:projectId/classification-systems
• GET v1/projects/:projectId/classification-systems/:systemId
• GET v1/projects/:projectId/classification-systems/:systemId/classifications
• GET v1/projects/:projectId/content-views
• GET v1/projects/:projectId/packages
• GET v1/projects/:projectId/packages/:packageId
• GET v1/projects/:projectId/packages/:packageId/takeoff-items
• GET v1/projects/:projectId/packages/:packageId/takeoff-items/:takeoffItemId
• GET v1/projects/:projectId/packages/:packageId/takeoff-types
• GET v1/projects/:projectId/packages/:packageId/takeoff-types/:takeoffTypeId
• GET v1/projects/:projectId/settings

| 300 | Per user account |

Data-Modification Endpoints

This rate limit applies to all endpoints that modify (create, update, or delete) data.

• POST v1/projects/:projectId/classification-systems
• DELETE v1/projects/:projectId/classification-systems/:systemId
• POST v1/projects/:projectId/classification-systems/:systemId/classifications:import
• PATCH v1/projects/:projectId/packages/:packageId
• POST v1/projects/:projectId/packages
• PATCH v1/projects/:projectId/settings

| 50 | Per user account |

Scope

Each rate limit is measured across the entire combined set of that rate limit’s API endpoints for each user account. As an example, if during one minute one application makes 300 requests of GET v1/projects/:projectId/packages/:packageId/takeoff-items under user account X, and a second application makes 100 requests of GET v1/projects/:projectId/packages/:packageId/takeoff-types under the same user account X, their combined rate is 400 requests per minute, which exceeds the data-reading endpoint rate limit.

Violation Notification

If an application makes a Takeoff API request that exceeds this rate limit, the Takeoff service returns an HTTP 429 error (described in detail in APS Rate Limits and Quotas).

Changing Limits

APS Rate Limits and Quotas describes how to request rate limit changes for APS APIs.

Imported from the Autodesk Platform Services documentation: https://aps.autodesk.com/en/docs/acc/v1/overview/rate-limits/takeoff-rate-limits.