Protocol

API Access

To gain access to the Streamdiver API, talk to our sales team for setting up a tenant. Once the signup process is completed, we will provide a clientId and secret to get you started.

OpenAPI Specification File

OpenAPI is a standard format for describing RESTful APIs that enables integration for those APIs with tools for a variety of applications, including testing, IDE integration and in particular client library generation. You can download the Streamdiver OpenAPI specification here.

API Protocols and Headers

The Streamdiver API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The HTTP responses follow the JSend JSON specification. The Streamdiver API is served over HTTPS TLS v1.2+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.2 are not supported.

Common Response Attributes

The Streamdiver API responses adhere to a standardized structure to ensure clarity and consistency. The following are the common attributes you can expect in a response:

Field	Type	Description
status	string	Indicates the status of the response. It can take one of three values: success, fail, or error. This field provides a high-level overview of the outcome.
data	object	Holds the actual content of the response. Its structure and content depend on the specific endpoint and the type of request made. In a success response, this typically contains the requested data.
message	string	Provides additional information about the response status. It's especially useful in cases where an error or failure occurs, offering details about what went wrong.