Welcome to SignalWire's REST API. Our REST API is a set of endpoints that make interacting with SignalWire, simple and familiar.

The REST API is structured like most other REST APIs: we use predictable and clear resource-oriented URLs that utilize built-in HTTP features like authentication, verbs and error codes. This enables you to easily use any HTTP client in any language to make requests.

Proper HTTP status codes and JSON are returned in all REST API endpoints, including errors.

Be sure to subscribe to the SignalWire Community for information on new features and changes to the API and language libraries.

Video API system overview

Any application built on top of the SignalWire Video APIs is typically part of the interaction between three different systems: SignalWire's servers, your own server, and your client (for example, a browser), as illustrated in the following diagram.

Sequence diagram of a possible interaction using the Video APISequence diagram of a possible interaction using the Video API

Sequence diagram of a possible interaction using the Video API

You are now looking at the documentation that describes the interactions between your server and SignalWire's servers.

For interactions between a client and SignalWire's servers, you may want to look at the Client SDKs.