Particle Cloud API
★ Only Publicly Available OpenAPI DocumentIOTDevice Managementbearer12 EndpointsREST
For Agents
Control Particle IoT devices remotely - call device functions, read sensor variables, manage access tokens, and subscribe to real-time device events.
Use for: I need to call a function on my Particle device, I want to read the current temperature variable from my sensor, Subscribe to the event stream for my fleet of devices, List all devices registered to my account
Not supported: Does not handle firmware compilation, device provisioning hardware setup, or mesh network topology - use for cloud-based device interaction and event streaming only.
Jentic publishes the only available OpenAPI specification for Particle Cloud API, keeping it validated and agent-ready. Provision and control Particle IoT devices over the cloud, including calling remote functions, reading device variables, and streaming real-time events via SSE. The API handles access token lifecycle management with OAuth 2.0 and supports fleet-wide event publishing across 12 endpoints covering device interaction, event streaming, and authentication.
Install Jentic One Beta
Connect the Particle Cloud API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Particle Cloud API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fparticle.io%2Fparticle" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fparticle.io%2Fparticle" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Particle Cloud API.
Call remote functions on connected Particle devices and receive return values
Read real-time sensor variables from any online device in your fleet
Subscribe to server-sent event streams for device state changes and custom events
Publish events to all devices in a product fleet simultaneously
Generate scoped OAuth access tokens for device-level or organization-level permissions
Wake sleeping mesh-network devices on demand for battery-efficient communication
Use Cases
Patterns agents use Particle Cloud API for, with concrete tasks.
★ AI Agent IoT Device Control
AI agents discover and invoke Particle device functions through Jentic's intent-based search without pre-configuring device IDs or function signatures. An agent searches for 'call a function on an IoT device', receives the POST /devices/{deviceId}/{functionName} schema, and executes the call with proper authentication handled by Jentic's credential vault. This pattern enables autonomous device control in smart factory, agriculture, and environmental monitoring scenarios.
Call the 'toggleRelay' function on device 0123456789abcdef with argument 'on' and verify the return value is 1
Real-Time Sensor Data Collection
Collect live sensor readings from deployed Particle devices by subscribing to server-sent event streams or polling device variables directly. The GET /events endpoint delivers real-time SSE streams filtered by event name, while GET /devices/{deviceId}/{functionName} returns the current value of any exposed variable. Supports fleet-wide monitoring across hundreds of devices with a single authenticated connection.
Read the 'humidity' variable from device abc123 and subscribe to the 'temperature' event stream to collect readings for 60 seconds
Fleet Event Broadcasting
Broadcast custom events to an entire fleet of Particle devices using the POST /events endpoint. Devices listen for named events and trigger firmware-defined handlers, enabling coordinated firmware updates, configuration changes, or emergency shutdown sequences across thousands of devices simultaneously without addressing each one individually.
Publish a 'config_update' event with data payload '{"interval": 30}' to trigger all fleet devices to update their reporting frequency
Access Token Lifecycle Management
Generate, list, and revoke OAuth access tokens for fine-grained API access control. The POST /oauth/token endpoint creates new tokens with configurable expiration, while DELETE /access_tokens/{token} enables immediate revocation for security incidents or credential rotation. Supports both user-level and product-level token scoping for multi-tenant IoT deployments.
Generate a new access token with 24-hour expiration using client credentials, then list all active tokens to confirm creation
Key Endpoints
12 endpoints — jentic publishes the only available openapi specification for particle cloud api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/devices/{deviceId}/{functionName}
Call a function on a Particle device
GET
/devices/{deviceId}/{functionName}
Read a variable from a device
GET
/devices
List all devices for the authenticated user
GET
/events
Subscribe to server-sent event stream
POST
/events
Publish an event to devices
POST
/oauth/token
Generate a new access token
POST
/devices/{deviceId}/wakeup
Wake a sleeping device
DELETE
/access_tokens/{token}
Revoke a specific access token
POST
/devices/{deviceId}/{functionName}
Call a function on a Particle device
GET
/devices/{deviceId}/{functionName}
Read a variable from a device
GET
/devices
List all devices for the authenticated user
GET
/events
Subscribe to server-sent event stream
POST
/events
Publish an event to devices
POST
/oauth/token
Generate a new access token
POST
/devices/{deviceId}/wakeup
Wake a sleeping device
DELETE
/access_tokens/{token}
Revoke a specific access token
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Particle Cloud API by hand means learning its bearer token auth and OAuth token flow, setting the api.particle.io/v1 host, and building event-stream and error handling yourself. Through Jentic you install once, import Particle Cloud from the API Directory, store the token once, and your agent calls it.
Permission scoping
Particle puts the device id in the URL path (/devices/{deviceId}/...), so a rule can pin your agent to one device: it can call functions, read variables, and wake that device. You choose the operations it may call, so destructive ones like revoking an access token are not included unless you add them.
Credential isolation
Your Particle access token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'call a function on an IoT device' or 'publish a device event', and Jentic returns the matching Particle operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Particle Cloud API through Jentic.
Why is there no official OpenAPI spec for Particle Cloud API?
Particle does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Particle Cloud API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Particle Cloud API use?
The Particle Cloud API uses Bearer token authentication. Tokens are obtained via the POST /oauth/token endpoint using client credentials (client_id and client_secret). Through Jentic, these credentials are stored in the encrypted Jentic One instance and agents receive scoped tokens without handling raw secrets.
Can I call a function on a specific Particle device through this API?
Yes. Send a POST request to /devices/{deviceId}/{functionName} with optional arguments in the request body. The device executes the firmware-defined function and returns an integer result value. Functions must be registered in device firmware using Particle.function().
How do I stream real-time events from Particle devices through Jentic?
Use the GET /events endpoint which returns a server-sent event (SSE) stream. Through Jentic, search for 'subscribe to Particle device events' to get the operation schema, then execute with your event name filter. The stream delivers events as they occur with device ID, timestamp, and payload data.
What are the rate limits for the Particle Cloud API?
The Particle Cloud API enforces rate limits per access token. Device function calls and variable reads are limited to approximately 120 requests per minute per device. The event publishing endpoint allows roughly 1 event per second per device. SSE stream connections are limited to 4 concurrent connections per access token.
Can I wake a sleeping Particle device using this API?
Yes. The POST /devices/{deviceId}/wakeup endpoint sends a wake signal to mesh-network devices in sleep mode. This is useful for battery-powered sensors where you need an on-demand reading without waiting for the device's normal wake cycle.
Can I limit what my agent is allowed to do with the Particle Cloud API?
Yes. Because you run Jentic One yourself, your own rules decide which Particle operations and credentials the agent may use. Since Particle puts the device id in the URL path (/devices/{deviceId}/...), a rule can pin your agent to a single device so it can only call that device's functions, read its variables, and wake it. You choose which operations are allowed, so destructive calls like revoking an access token stay off the list unless you add them.
GET STARTED