Download OpenAPI specification:
Hardware-level functionality of the wyrecore platform.
All endpoints are accessed via the base URL with the /api/v1 prefix.
Authentication is required for all endpoints except /api/v1/health. Use API credentials in the Authorization header: Bearer wyre_CLIENT_ID:SECRET
Please visit contact the Developer Support Team to receive the API base URL and API credentials.
Publishes a command to a specific Root Controller.
| rcId required | string The unique identifier of the Root Controller |
The command to publish
| command_type required | string The type of command to execute |
| payload required | object Command-specific payload data |
| expires_at required | string <date-time> ISO 8601 timestamp when the command expires |
| correlation_id | string <uuid> Optional correlation ID for tracking (generated if not provided) |
{- "command_type": "set_pixels",
- "payload": {
- "commands": [
- {
- "address": "1.1",
- "start": 0,
- "count": 10,
- "colour": {
- "red": 255,
- "green": 128,
- "blue": 0
}
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "correlation_id": "123e4567-e89b-12d3-a456-426614174000"
}{- "status": "command published",
- "correlation_id": "123e4567-e89b-12d3-a456-426614174000"
}Publishes multiple commands to a specific Root Controller in a single batch request.
| rcId required | string The unique identifier of the Root Controller |
The batch of commands to publish
required | Array of objects (CommandRequest) non-empty Array of commands to execute |
{- "commands": [
- {
- "command_type": "set_pixels",
- "payload": {
- "commands": [
- {
- "address": "1.1",
- "start": 0,
- "count": 10,
- "colour": {
- "red": 255,
- "green": 128,
- "blue": 0
}
}
]
}, - "expires_at": "2019-08-24T14:15:22Z",
- "correlation_id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}{- "status": "all commands published",
- "results": [
- {
- "status": "published",
- "correlation_id": "123e4567-e89b-12d3-a456-426614174000",
- "error": "Message has already expired"
}
]
}Gets the last known status of a specific Root Controller.
| rcId required | string The unique identifier of the Root Controller |
{- "id": "aa:bb:cc:dd:ee:ff",
- "last_heartbeat": "2019-08-24T14:15:22Z"
}Gets the latest nodes list for a specific Root Controller.
| rcId required | string The unique identifier of the Root Controller |
{- "id": "aa:bb:cc:dd:ee:ff",
- "nodes": [
- {
- "serial_number": "ABC123456",
- "address": "1.1",
- "node_type": "speaker",
- "is_online": true,
- "last_seen": "2023-01-01T12:00:00Z",
- "uptime_seconds": 3600,
- "firmware_version": "1.0.0"
}
]
}