|
1 | 1 | --- |
2 | | -title: 'Overview' |
| 2 | +title: "API Reference" |
| 3 | +description: "Complete reference for all Seam API resources and endpoints." |
3 | 4 | --- |
4 | 5 |
|
5 | | -This API reference provides a comprehensive listing of all the Seam API resources and endpoints. It also explains how to install the Seam SDKs that enable you to use Seam in the programming language of your choice. |
| 6 | +The Seam API lets you control smart locks, thermostats, access control systems, and more through a unified REST interface. All endpoints use `https://connect.getseam.com` as the base URL. |
6 | 7 |
|
7 | | -See the following reference topics: |
| 8 | +<CardGroup cols={2}> |
| 9 | + <Card title="SDK Installation" icon="download" href="/api/installation"> |
| 10 | + Install the Seam SDK for JavaScript, Python, Ruby, PHP, C#, or Go. |
| 11 | + </Card> |
| 12 | + <Card title="MCP Installation" icon="plug" href="/api/mcp-installation"> |
| 13 | + Connect Seam to AI assistants via the Model Context Protocol. |
| 14 | + </Card> |
| 15 | + <Card title="Authentication" icon="key" href="/api/authentication"> |
| 16 | + Authenticate with API keys, client session tokens, or personal access tokens. |
| 17 | + </Card> |
| 18 | + <Card title="Pagination" icon="list" href="/api/pagination"> |
| 19 | + Navigate large result sets with cursor-based pagination. |
| 20 | + </Card> |
| 21 | +</CardGroup> |
8 | 22 |
|
9 | | -## Getting Started |
| 23 | +## Granting Access |
10 | 24 |
|
11 | | -- [SDK Installation](installation.md) |
12 | | -- [MCP Installation](mcp-installation.md) |
13 | | -- [Authentication](authentication.md) |
14 | | -- [Client Sessions](client_sessions/) |
15 | | -- [Workspaces](workspaces/) |
| 25 | +Manage how people access physical spaces — PIN codes, mobile keys, key cards, and more. |
16 | 26 |
|
17 | | -## Controlling Devices and Systems |
| 27 | +<CardGroup cols={3}> |
| 28 | + <Card title="Access Grants" icon="id-badge" href="/api/access_grants"> |
| 29 | + Create, update, and revoke access grants. |
| 30 | + </Card> |
| 31 | + <Card title="Access Methods" icon="door-open" href="/api/access_methods"> |
| 32 | + Manage individual access methods within a grant. |
| 33 | + </Card> |
| 34 | + <Card title="Access Codes" icon="input-numeric" href="/api/access_codes"> |
| 35 | + Program PIN codes on smart lock keypads. |
| 36 | + </Card> |
| 37 | +</CardGroup> |
18 | 38 |
|
19 | | -- [Connect Webviews](connect_webviews/) |
20 | | -- [Devices](devices/) |
21 | | - - [Locks](locks/) |
22 | | - - [Access Codes](access_codes/) |
23 | | - - [Thermostats](thermostats/) |
24 | | - - [Noise Sensors](noise_sensors/) |
25 | | -- [Access Control Systems](acs/) |
26 | | - - [User Identities](user_identities/) |
27 | | - - [Phones](phones/) |
| 39 | +## Devices and Systems |
| 40 | + |
| 41 | +Connect and control IoT hardware through a unified interface. |
| 42 | + |
| 43 | +<CardGroup cols={3}> |
| 44 | + <Card title="Devices" icon="microchip" href="/api/devices"> |
| 45 | + List, get, and update connected devices. |
| 46 | + </Card> |
| 47 | + <Card title="Locks" icon="lock" href="/api/locks"> |
| 48 | + Lock and unlock smart locks. |
| 49 | + </Card> |
| 50 | + <Card title="Thermostats" icon="temperature-half" href="/api/thermostats"> |
| 51 | + Set temperature, HVAC mode, and climate presets. |
| 52 | + </Card> |
| 53 | + <Card title="Noise Sensors" icon="volume-high" href="/api/noise_sensors"> |
| 54 | + Monitor noise levels and configure thresholds. |
| 55 | + </Card> |
| 56 | + <Card title="Spaces" icon="building" href="/api/spaces"> |
| 57 | + Organize devices and entrances into named spaces. |
| 58 | + </Card> |
| 59 | + <Card title="Phones" icon="mobile" href="/api/phones"> |
| 60 | + Manage phones for mobile access credentials. |
| 61 | + </Card> |
| 62 | +</CardGroup> |
| 63 | + |
| 64 | +## Access Control Systems |
| 65 | + |
| 66 | +Manage enterprise access control systems — users, credentials, entrances, and encoders. |
| 67 | + |
| 68 | +<CardGroup cols={3}> |
| 69 | + <Card title="ACS Systems" icon="server" href="/api/acs"> |
| 70 | + Connect and manage access control systems. |
| 71 | + </Card> |
| 72 | + <Card title="User Identities" icon="user" href="/api/user_identities"> |
| 73 | + Map your users to Seam for cross-system identity management. |
| 74 | + </Card> |
| 75 | + <Card title="Instant Keys" icon="bolt" href="/api/instant_keys"> |
| 76 | + Issue temporary mobile keys without an app install. |
| 77 | + </Card> |
| 78 | +</CardGroup> |
| 79 | + |
| 80 | +## Account Management |
| 81 | + |
| 82 | +Set up workspaces, connect device accounts, and configure webhooks. |
| 83 | + |
| 84 | +<CardGroup cols={3}> |
| 85 | + <Card title="Connect Webviews" icon="window-restore" href="/api/connect_webviews"> |
| 86 | + Launch authorization flows to connect user device accounts. |
| 87 | + </Card> |
| 88 | + <Card title="Connected Accounts" icon="link" href="/api/connected_accounts"> |
| 89 | + Manage linked manufacturer accounts. |
| 90 | + </Card> |
| 91 | + <Card title="Client Sessions" icon="user-shield" href="/api/client_sessions"> |
| 92 | + Create scoped sessions for frontend applications. |
| 93 | + </Card> |
| 94 | + <Card title="Workspaces" icon="briefcase" href="/api/workspaces"> |
| 95 | + Create and manage sandbox and production workspaces. |
| 96 | + </Card> |
| 97 | + <Card title="Webhooks" icon="bell" href="/api/webhooks"> |
| 98 | + Subscribe to real-time event notifications. |
| 99 | + </Card> |
| 100 | + <Card title="Customers" icon="users" href="/api/customers"> |
| 101 | + Manage customer portals and data. |
| 102 | + </Card> |
| 103 | +</CardGroup> |
28 | 104 |
|
29 | 105 | ## Monitoring |
30 | 106 |
|
31 | | -- [Events](events/) |
32 | | -- [Action Attempts](action_attempts/) |
33 | | -- [Connected Accounts](connected_accounts/) |
| 107 | +Track events, poll for action completion, and handle errors. |
| 108 | + |
| 109 | +<CardGroup cols={3}> |
| 110 | + <Card title="Events" icon="timeline" href="/api/events"> |
| 111 | + Query device and system events. |
| 112 | + </Card> |
| 113 | + <Card title="Action Attempts" icon="spinner" href="/api/action_attempts"> |
| 114 | + Poll async operations until completion. |
| 115 | + </Card> |
| 116 | +</CardGroup> |
0 commit comments