Explore the API documentation for [Heapstream.com](//heapstream.com)! ## Authentication Authentication is done through Basic Authentication [wikipedia](https://en.wikipedia.org/wiki/Basic_access_authentication) [RFC7617](https://datatracker.ietf.org/doc/html/rfc7617). For `username` you should use the `id` of the ApiKey. For `password` you should use the `password` of the ApiKey.
Project description
Heapstream Python SDK 1.1.0
Welcome to the Heapstream SDK documentation. This guide will help you get started with integrating and using the Heapstream SDK in your project.
Versions
- API version:
1.0 - SDK version:
1.1.0
About the API
Explore the API documentation for Heapstream.com! ## Authentication Authentication is done through Basic Authentication wikipedia RFC7617. For username you should use the id of the ApiKey. For password you should use the password of the ApiKey.
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: Python >= 3.7
Installation
To get started with the SDK, we recommend installing using pip:
pip install heapstream
Authentication
Basic Authentication
The Heapstream API uses Basic Authentication.
You need to provide your username and password when initializing the SDK.
Setting the Username and Password
When you initialize the SDK, you can set the username and password as follows:
Heapstream(
username="YOUR_USERNAME",
password="YOUR_PASSWORD",
timeout=10000
)
If you need to set or update the username and password after initializing the SDK, you can use:
sdk.set_basic_auth("YOUR_USERNAME", "YOUR_PASSWORD")
Setting a Custom Timeout
You can set a custom timeout for the SDK's HTTP requests as follows:
from heapstream import Heapstream
sdk = Heapstream(timeout=10000)
Sample Usage
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
from heapstream import Heapstream
sdk = Heapstream(
username="YOUR_USERNAME",
password="YOUR_PASSWORD",
timeout=10000
)
result = sdk.project.list_projects()
print(result)
Services
The SDK provides various services to interact with the API.
Below is a list of all available services:
| Name |
|---|
| project |
| direct_upload |
| player |
| stats |
| video |
| audio_track |
| poster |
| text_track |
| watermark |
| webhook |
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models:
| Name | Description |
|---|---|
| ProjectList | |
| ProjectCreate | |
| Project | |
| ProjectEdit | |
| DirectUploadStart | Schema used to start a multipart direct upload to our S3 storage. |
| DirectUploadResponse | |
| DirectUploadListPart | |
| DirectUploadCompleteArgs | |
| PartIdResponse | |
| PlayerList | |
| PlayerCreate | |
| Player | |
| PlayerEdit | |
| EngagementStats | |
| PerformanceStats | |
| VideoList | |
| VideoStatus | |
| VideoFetch | |
| Video | |
| VideoEdit | |
| PresetList | |
| AudioTrackList | |
| AudioTrackCreate | |
| AudioTrack | |
| AudioTrackEdit | |
| PosterList | |
| MultipartFile | |
| Poster | |
| PosterEdit | |
| TextTrackList | |
| TextTrackCreate | |
| TextTrack | |
| TextTrackGenerate | |
| TextTrackEdit | |
| WatermarkList | |
| WatermarkCreate | |
| Watermark | |
| WebhookList | |
| WebhookCreate | |
| Webhook | |
| TtAutoLang | |
| UploadMetadata | The nested schema to upload a video. |
| EncodingTier | |
| Asset | |
| AssetError | |
| AssetErrorType | |
| DirectUploadPart | |
| PlayerLogoPosition | |
| PlayerSkin | |
| OnlyTrueEnum | |
| EngagementStatsRow | |
| PerformanceStatsRow | |
| Pagination | Pagination response schema Used to serialize pagination metadata. Its main purpose is to document the pagination metadata. |
| Preset | |
| PresetType | |
| AudioTrackStatus | |
| AudioTrackType | |
| TextTrackStatus | |
| TextTrackType | |
| TextTrackUploadType | |
| AutoCaption | |
| WatermarkPosition |
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.
