API Reference

Comprehensive reference documentation for Blues developer APIs

Notecard API

APIs for interacting with the Notecard in host firmware.

APIs for interacting with Notehub over HTTP.

Base URL: https://api.notefile.net
Authentication: every request carries an OAuth 2.0 bearer token in an Authorization: Bearer header. Tokens come from the Authorization API using a client ID and secret created in your Notehub project — see Authentication.
Usage limits: 7 requests per minute per billing account free of charge; a 429 response means the threshold was exceeded. See Usage Limits.
Machine-readable: OpenAPI 3 specification, Postman collection, and the notehub-js and notehub-py SDKs.

Example: list the devices in a project.

curl -L 'https://api.notefile.net/v1/projects/app:00000000-0000-0000-0000-000000000000/devices' \
  -H 'Authorization: Bearer <token>'

Transport: newline-terminated JSON objects over Serial, USB, or I2C from your host firmware — see the Notecard API introduction.
Shape: a req (or cmd for no reply) plus the request's arguments; the reply is a JSON object, with an err field on failure.
Try it: the in-browser terminal sends requests to a Notecard connected over USB.

Example: connect a Notecard to a Notehub project.

{"req":"hub.set","product":"com.your-company:your-product-name","mode":"periodic","outbound":60}

A comprehensive listing of terms and definitions used throughout Blues hardware and services.

A reference of all Notefiles created automatically on the Notecard and/or on Notehub.