Skip to content

Commit cf5b00e

Browse files
louis-preclaude
andcommitted
docs: Move rate limits to API reference and smart locks guide to guides
Rate Limits and Guardrails page belongs with the API reference docs rather than developer tools. Get started with Smart Locks is a capability guide, not a brand guide. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent d342dbc commit cf5b00e

7 files changed

Lines changed: 26 additions & 7 deletions

File tree

codegen/lib/summary.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ const getUpdatedSummary = (summary: string, apiSummary: string): string => {
3030
const lines = summary.split('\n')
3131

3232
const startIdx = lines.findIndex(
33-
(line) => line.trim() === '* [Pagination](pagination.md)',
33+
(line) =>
34+
line.trim() ===
35+
'* [Rate Limits and Guardrails](rate-limits-and-guardrails.md)',
3436
)
3537
if (startIdx === -1) {
3638
throw new Error('Could not find start of API summary')

docs/guides/developer-tools/rate-limits-and-guardrails.md renamed to codegen/source/docs/api-reference/rate-limits-and-guardrails.md

File renamed without changes.

docs/api-reference/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* [Installation](installation.md)
55
* [Authentication](authentication.md)
66
* [Pagination](pagination.md)
7+
* [Rate Limits and Guardrails](rate-limits-and-guardrails.md)
78
* [Access Codes](access_codes/README.md)
89
* [Create an Access Code](access_codes/create.md)
910
* [Create Multiple Linked Access Codes](access_codes/create_multiple.md)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
description: >-
3+
Learn about the rate limits and guardrails that Seam uses to maintain reliable
4+
service for all users.
5+
---
6+
7+
# Rate Limits and Guardrails
8+
9+
In order to provide reliable service for all of our customers and API load predictability for our device partners, we have a number of rate limits and guardrails in place.
10+
11+
## Rate Limits
12+
13+
For requests with rate limits, exceeding these limits results in the corresponding API calls failing with a `429 Too Many Requests` response. You must then retry your request after the appropriate amount of time.
14+
15+
We enforce the following rate limits on a per-device basis:
16+
17+
<table><thead><tr><th width="243">Operation</th><th>Limit</th></tr></thead><tbody><tr><td><a href="https://docs.seam.co/latest/api/access_codes/create">Create an access code</a></td><td>10 access code creations per minute</td></tr><tr><td><a href="https://docs.seam.co/latest/api/access_codes/update">Update an access code</a></td><td>10 access code updates per minute</td></tr><tr><td><a href="https://docs.seam.co/latest/api/access_codes/delete">Delete an access code</a></td><td>20 access code deletions per minute</td></tr><tr><td><a href="https://docs.seam.co/latest/api/locks/lock_door">Lock a lock</a></td><td>15 lock requests per minute</td></tr><tr><td><a href="https://docs.seam.co/latest/api/locks/unlock_door">Unlock a lock</a></td><td>15 unlock requests per minute</td></tr></tbody></table>

docs/brand-guides/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,4 +186,3 @@
186186
* [Yale Locks](yale-locks/README.md)
187187
* [Get started with Yale Locks](yale-locks/get-started-with-yale-locks.md)
188188
* [Sandbox Yale Locks](yale-locks/yale-sample-data.md)
189-
* [Get started with Smart Locks](get-started-with-smartlocks-api.md)

docs/guides/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444

4545
* [Device and System Capabilities](capability-guides/device-and-system-capabilities.md)
4646
* [Smart Locks](capability-guides/smart-locks/README.md)
47+
* [Get started with Smart Locks](capability-guides/smart-locks/get-started-with-smartlocks-api.md)
4748
* [Locking and Unlocking Smart Locks](capability-guides/smart-locks/lock-and-unlock.md)
4849
* [Creating and Managing Smart Lock Access Codes](capability-guides/smart-locks/access-codes/README.md)
4950
* [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md)
@@ -166,7 +167,6 @@
166167
* [Webhooks](developer-tools/webhooks.md)
167168
* [Seam CLI](developer-tools/seam-cli.md)
168169
* [Seam MCP Server](developer-tools/seam-mcp.md)
169-
* [Rate Limits and Guardrails](developer-tools/rate-limits-and-guardrails.md)
170170
* [Mobile SDKs](developer-tools/mobile-sdks/README.md)
171171
* [Android SDK](developer-tools/mobile-sdks/android-sdk.md)
172172
* [iOS SDK](developer-tools/mobile-sdks/ios-sdk.md)

docs/brand-guides/get-started-with-smartlocks-api.md renamed to docs/guides/capability-guides/smart-locks/get-started-with-smartlocks-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -483,9 +483,9 @@ $seam->access_codes->create(
483483

484484
Now that you've completed this guide, you can try to build a real application to connect and control a device. Don't hesitate to reach out to our team if we can help with anything, or explore other aspects of Seam, here is a list of helpful resources:
485485

486-
* [Yale Getting Started Guide](yale-locks/get-started-with-yale-locks.md)
487-
* [August Getting Started Guide](august-locks/get-started-with-august-locks.md)
488-
* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md)
489-
* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md)
486+
* [Yale Getting Started Guide](https://docs.seam.co/latest/device-and-system-integration-guides/yale-locks/get-started-with-yale-locks)
487+
* [August Getting Started Guide](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks/get-started-with-august-locks)
488+
* [Schlage Getting Started Guide](https://docs.seam.co/latest/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks)
489+
* [SmartThings Getting Started Guide](https://docs.seam.co/latest/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks)
490490
* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list)
491491
* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview)

0 commit comments

Comments
 (0)