sophon-sdk 0.1.0

SOPHON Encoding API

sophon-sdk

REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.

Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.1.0
• Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://liqhtworks.xyz

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/Liqhtworks/sophon-sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Liqhtworks/sophon-sdk-python.git)

Then import the package:

import sophon_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sophon_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sophon_sdk
from sophon_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.liqhtworks.xyz
# See configuration.py for a list of all supported configuration parameters.
configuration = sophon_sdk.Configuration(
    host = "https://api.liqhtworks.xyz"
)



# Enter a context with an instance of the API client
with sophon_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sophon_sdk.DownloadsApi(api_client)
    token = 'token_example' # str | HMAC-signed download token encoding the object key and expiry.

    try:
        # Download an output file via signed token
        api_response = api_instance.download(token)
        print("The response of DownloadsApi->download:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DownloadsApi->download: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.liqhtworks.xyz

Class	Method	HTTP request	Description
DownloadsApi	download	GET /v1/downloads/{token}	Download an output file via signed token
HealthApi	healthz	GET /healthz	Liveness probe
HealthApi	readyz	GET /readyz	Readiness probe
JobsApi	cancel_job	DELETE /v1/jobs/{id}	Cancel a job
JobsApi	create_job	POST /v1/jobs	Submit an encoding job
JobsApi	get_job	GET /v1/jobs/{id}	Get a single job by ID
JobsApi	get_job_output	GET /v1/jobs/{id}/output	Get the encoded output file
JobsApi	list_jobs	GET /v1/jobs	List jobs with cursor pagination
UploadsApi	cancel_upload	DELETE /v1/uploads/{id}	Cancel an upload session
UploadsApi	complete_upload	POST /v1/uploads/{id}/complete	Finalize a chunked upload
UploadsApi	create_upload	POST /v1/uploads	Initialize a chunked upload session
UploadsApi	get_upload	GET /v1/uploads/{id}	Get upload session status
UploadsApi	upload_part	PUT /v1/uploads/{id}/parts/{part_number}	Upload a single chunk
WebhooksApi	create_webhook	POST /v1/webhooks	Register a webhook endpoint
WebhooksApi	delete_webhook	DELETE /v1/webhooks/{id}	Soft-delete a webhook endpoint
WebhooksApi	list_webhooks	GET /v1/webhooks	List active webhook endpoints

Documentation For Models

• CompleteUploadResponse
• CreateJobOutputOptions
• CreateJobRequest
• CreateUploadRequest
• CreateUploadResponse
• CreateWebhookRequest
• ErrorBody
• ErrorEnvelope
• JobOutputInfo
• JobProfile
• JobProgress
• JobResponse
• JobSourceInfo
• JobSourceType
• JobStatus
• ListJobsResponse
• OutputContainer
• ReadyResponse
• UploadJobSource
• UploadPartResponse
• UploadStatusResponse
• WebhookDeliveryPayload
• WebhookListItem
• WebhookListResponse
• WebhookResponse

Documentation For Authorization

Authentication schemes defined for the API:

bearerApiKey

• Type: Bearer authentication

sessionCookie

• Type: API key
• API key parameter name: sophon_api_session
• Location:

Author