Menu

Expand
Rate this page:

The Microvisor API

Microvisor Public Beta

Microvisor is in a pre-release phase and the information contained in this document is subject to change. Some features referenced below may not be fully available until Microvisor’s General Availability (GA) release.

Twilio IoT’s Microvisor API allows you to manage Microvisor-empowered devices and the applications they run — and to do so from anywhere in the world.

If you are looking for the Microvisor C language interface for device programming, please see the Microvisor System Calls.

The Microvisor API base URL

Almost all URLs in the reference documentation use the following base URL:

https://microvisor.twilio.com/v1

The API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. All responses are provided in JSON format.

You don’t need to use the .json file extension in API request URIs.

API resources

The Microvisor API comprises the following resources:

Resource Description
Device Interact with individual IoT devices
App Manage and deploy application firmware

On May 14, 2022, the organization of data within device resources changed and introduced alternative field names. This is a breaking change. Please review the updated documentation below and update any code which works with device resources.

API resource properties

When you create or update resources, you indicate the data that is being added or changed by specifying the appropriate resource property. All resource properties are case-sensitive and written in UpperCamelCase. For example, if you want to change a new Device’s unique name, you call:

curl https://microvisor.twilio.com/v1/Devices/{Device SID} \
  -d 'UniqueName=My Microvisor IoT Device'
  -u '{Account_Sid}:{Auth_Token}'

This contrasts with responses from the API, in which properties are referenced using lower_snake_case. For example, getting that same Device’s details will return:

{
  "sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "unique_name": "My Microvisor IoT Device",
  "logging_enabled": true,
  "date_logging_expires": ""2021-10-22T19:00:00Z",
  "app_update": null,
    "info", null,
  "status": "up-to-date",
  "date_created": "2021-10-21T19:00:00Z",
  "date_updated": "2021-10-21T20:00:00Z",
  "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

The API documentation presents the appropriate parameter formatting for the language or tool that you select in the code column.

API authentication

HTTPS requests made to the Microvisor API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, please refer to our security documentation.

You will use your Twilio Account SID as the username and your Auth Token as the password. For example, using the command line tool curl to get a list of your Device resources, you would use:

curl https://microvisor.twilio.com/v1/Devices \
  -u '{Account_Sid}:{Auth_Token}'

You can find your Account SID and Auth Token in the Console.

To learn more about authentication and interaction with the Twilio REST API, see our documentation for requests to the API and Twilio’s response.

API request errors

Errors are signaled by 4xx and 5xx HTTP response status codes and a JSON response body. The error data is a standard Twilio structure. For example:

{
  "code": 20003, 
  "detail": "Your AccountSid or AuthToken was incorrect.", 
  "message": "Authentication Error - No credentials provided", 
  "more_info": "https://www.twilio.com/docs/errors/20003", 
  "status": 401
}

As you can see, the JSON gives you a human- and machine-readable indication of the nature (detail) and cause (message) of the error, and a reference to a more detailed description of the error in Twilio’s documentation. The value of code is a Twilio error code, and is referenced again in the more_info URL.

You can see a list of all such codes in the error code documentation and as a JSON file.

Help integrating the Microvisor API

Twilio’s Microvisor API is a flexible building block which can take you from working with your first Microvisor-empowered IoT device to managing a fleet of millions of such devices.

While we hope this page gives a good overview of what you can do with the API, we’re only scratching the surface of what the Microvisor API can do.

If you need any help integrating the Microvisor API or want to talk about best practices, please get in touch: just drop a line to support@twilio.com.

We can’t wait to see what you build!

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

Thank you for your feedback!

Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

thanks-feedback-gif