Ambient API
Build powerful integrations with our comprehensive REST API. Manage wallpapers, signatures, and campaigns programmatically.
RESTful API
Our API follows REST conventions with predictable resource-oriented URLs, JSON request/response bodies, and standard HTTP methods.
- OAuth 2.0 Authentication
Secure API access with bearer tokens and refresh flows
- Rate Limiting
Tenant-aware limits are enforced by plan and workload profile
- Webhooks
Real-time notifications for key events
- OpenAPI Spec
Full OpenAPI 3.0 specification available
API Resources
Everything you need to integrate Ambient into your workflows
Wallpapers
Create, update, and deploy wallpapers to endpoints. Schedule campaigns and track analytics.
/v1/wallpapers Signatures
Manage email signature templates, assign to users, and ensure compliance across your organization.
/v1/signatures Endpoints
Query and manage connected devices. View status, assign policies, and retrieve analytics.
/v1/endpoints Campaigns
Create and manage coordinated multi-channel campaigns with scheduling and targeting.
/v1/campaigns Analytics
Access detailed analytics data for impressions, engagement, and campaign performance.
/v1/analytics Users
Manage users, roles, and permissions. Integrate with SCIM for automated provisioning.
/v1/users SDKs & Libraries
Official SDKs to accelerate your integration
Python
pip install ambient-sdk Node.js
npm i @ambient/sdk C# / .NET
Install-Package Ambient.SDK Java
com.ambient:sdk Ready to Build?
Get started with our API documentation and SDKs. Our developer support team is here to help.