Live

Getting Started (1.0.0)

Cincopa REST API V2 to get/set and manipulate assets and galleries

Cincopa REST API V2 is a simple set of REST based methods that allow you to access almost every aspect of your galleries and assets. Authentication is done with a simple api_token that can be created and deleted per app, set the permission level according to the needed level and exposure level.

V2 API was designed to be used:

  • in server-to-server scenario where the api_token and information is not exposed to the public, in such scenario the permissions level can allow write and delete.
  • in client-to-server scenario like javascript request from a public web page, in this scenario permission level will be set to read only which ensures the safety of your web app. This unique architecture eliminates the need of creating a "proxy" service that usually needed when working with a 3rd party API thus saving you time in integration.
Download OpenAPI description
index.json
index.yaml
Overview
Cincopa API Support support@cincopa.com
License MIT
Languages
Servers
Cincopa API
https://api.cincopa.com/v2/

General

This section offers foundational API endpoints essential for establishing and validating connections with the Cincopa platform. These endpoints are designed to ensure smooth integration and secure interactions between your application and Cincopa's services.

Key FunctionalitiesEndpointPurpose
Validate API Connection/ping.jsonThis endpoint allows you to confirm the validity and responsiveness of your API connection. By sending a request to /ping.json with your api_token, you can verify that your application is properly authenticated and can communicate effectively with Cincopa's servers.
Obtain a Temporary Token/token.get_temp.jsonIn scenarios where frontend applications require direct interaction with Cincopa's API, this endpoint provides a secure method to generate temporary tokens. These tokens facilitate client-to-server communications, enabling operations like updating galleries or assets directly from client-side code without exposing permanent credentials.
Operations

Gallery

This section provides a comprehensive suite of methods for managing your media galleries. The Gallery API empowers developers to programmatically create, manage, and customize multimedia galleries for seamless integration into applications, websites, or digital platforms.

Whether you're building a media-rich portal, a dynamic content hub, or a branded video experience, this API provides granular control over gallery configurations, media assets, permissions, and display logic.

Key FunctionalitiesEndpointPurpose
Creating Galleries/gallery.create.jsonEstablish new media galleries to organize your content effectively.
Setting Gallery Metadata/gallery.set_meta.json Update gallery information such as title, description, and custom properties to keep your content organized and accessible.
Deleting Galleries/gallery.delete.jsonRemove galleries that are no longer needed, ensuring your media library stays current.
Adding Items to Galleries/gallery.add_item.jsonIncorporate new media assets into existing galleries to enhance your content offerings.
Removing Items from Galleries/gallery.remove_item.jsonManage your galleries by removing outdated or unwanted media assets.
Listing Galleries/gallery.list.jsonRetrieve a list of all galleries in your account for easy management and overview.
Retrieving Gallery Items/gallery.get_items.jsonAccess detailed information about the media assets contained within a specific gallery.
Setting Master Media/gallery.set_master.jsonDesignate a primary media asset within a gallery to highlight featured content.
Operations

Assets

This section provides a comprehensive suite of methods for managing assets within your account. The Assets API enables developers to efficiently upload, organize, modify, and retrieve digital assets, ensuring seamless integration into applications, websites, or media platforms.

Whether you're handling large media libraries, automating asset management, or implementing structured metadata, this API offers precise control over asset creation, metadata customization, categorization, and retrieval, enhancing workflow efficiency and content organization.

Key FunctionalitiesEndpointPurpose
List Assets/asset.list.jsonGet a list of assets in the account; those assets can be added to any gallery. Use search to locate specific assets or use reference_id to locate by reference_id of the asset.
List Tags/asset.get_tags.json Fetches all tags associated with assets for categorization and filtering. Returns a structured list for efficient metadata management.
Set meta data of an asset/asset.set_meta.jsonUpdates or adds metadata (title, description, custom fields) for a specific asset. Requires the asset ID and enhances searchability and organization.
Resync an asset/asset.resync.jsonResync an asset will start a process of checking for missing versions and generating them. This method is only needed in cases of a failure to sync a gallery.
Delete an asset/asset.delete.jsonDelete an asset for good, it will be removed also from any gallery that exists.
Get upload URL to POST an asset./asset.get_upload_url.jsonGet upload URL to your assets library, use this URL with an HTTP POST method. Asset can be added directly to a gallery or be attached to another asset to set the video poster, for example. When attaching to another asset, it must provide a type name.
Start uploading an asset from an input URL./asset.upload_from_url.jsonUpload an asset from an input URL. Asset can be added directly to a gallery or be attached to another asset to set the video poster, for example. When attaching to another asset, must provide a type name. This method will return a status ID that can be used by asset.upload_from_url_get_status to get information about the upload process and the ID of the uploaded asset when done.
Get status during and after the uploading process./asset.upload_from_url_get_status.jsonUse this method to get the Id of the uploaded asset when done.
Abort uploading process./asset.upload_from_url_abort.jsonUse this method to abort an upload.
Operations

Upload

This section provides you with a detailed overview of Cincopa's Upload API, which allows users to upload media files to their Cincopa galleries efficiently. The API offers two primary methods for uploading content: an embeddable iFrame for direct user uploads and a secure token-based system for controlled access. These options ensure flexibility, security, and ease of use, making it simple to integrate media uploads into your applications or websites.

With the embeddable iFrame, users can upload media directly through an interactive interface that supports drag-and-drop functionality, media selection, and content management features like metadata editing and file reordering. On the other hand, the token-based system ensures that only authorized users can upload media by generating a secure upload token.

Key FunctionalitiesEndpointPurpose
HTML iframe to manage gallery/upload.iframeProvides an embeddable iFrame URL for users to upload media directly to a Cincopa gallery. The interface supports drag-and-drop uploads, media selection, metadata editing, reordering, and deletion. It is fully responsive across devices.
Invite upload token/upload.get_upload_token.jsonGenerates a unique token that restricts access to the invite upload page, ensuring that only authorized users can upload media to a specified gallery.
Operations

Portal

This section provides a comprehensive suite of methods for managing and customizing portals. The Portal API allows developers to programmatically create, manage, and configure landing pages, video hubs, and share pages for seamless integration into applications, websites, or digital platforms.

Whether you're building a dynamic content hub, a multimedia-rich portal, or a branded video experience, this API offers full control over portal settings, status management, and retrieval of existing portals. The following table provides a breakdown of the available API endpoints and their functions:

Key FunctionalitiesEndpointPurpose
Verify subdomain/portal.check.jsonChecks if a portal exists and retrieves its status. This is useful for validating whether a portal is active before performing further operations.
Create subdomain if available/portal.cease.json Deactivates or ceases an existing portal. This operation is useful when a portal is no longer needed but should not be permanently deleted.
Rename subdomain/portal.rename.jsonRenames a specified portal by providing the existing portal ID and the new desired name. This helps in organizing portals efficiently.
Remove subdomain/portal.remove.jsonDeletes a portal from the system. This operation is irreversible and permanently removes all associated data.
Save subdomain/portal.set.jsonCreates a new portal or updates the settings of an existing one. This allows customization of portal properties such as name, visibility, and other configurations.
List of portals/portal.list.jsonRetrieves a list of all configured portals along with their details. This endpoint helps in managing multiple portals and tracking their statuses.
Operations

Webhook

This section provides a streamlined way to receive real-time notifications about account activities via HTTP POST callbacks. Instead of continuously polling for updates, webhooks allow external applications to listen for specific events and respond accordingly.

This API enables developers to automate workflows, synchronize data, and receive alerts whenever significant actions occur in the system. Additionally, the API supports Slack integration, allowing event notifications to be delivered directly to a Slack channel for easy monitoring and collaboration.

Key FunctionalitiesEndpointPurpose
List of webhooks/webhook.list.jsonRetrieves a list of all active webhooks associated with the account, including their configurations and callback URLs.
Create/update webhook/webhook.set.jsonRegisters a new webhook by specifying a callback URL and event types to trigger notifications.
Create/update webhook to slack/webhook.set_slack.jsonSets up a webhook that sends real-time event notifications directly to a Slack channel for instant updates.
Delete a webhook/webhhook.delete.jsonDeletes an existing webhook, stopping further event notifications and removing it from the system.
Operations

Live

Professional Live Video Streaming Service.

Operations

List of live streams

Request

Get all live streams registered in the account. The list will include liveid, rtmp_source is the address to which your source device should transmit, hls_playback_url is the URL of the hls file (m3u8), iframe_embed_code is an embed code for a player that already configured with this live stream.

Query
api_tokenstringrequired

The api_token to authorize the request.

curl -i -X GET \
  'https://api.cincopa.com/v2/live.list.json?api_token=string'

Responses

Successful response.

Bodyapplication/json
successboolean

Indicates whether the request was successful. true for success, false for failure.

Example: true
runtimeinteger

How long the request took to process in second or milisecond.

Example: 77
live_streamsArray of arrays
usageobject
Example: {"max_passthrough_quota":0,"max_transcoded_quota":0,"usage_passthrough":0,"usage_transcoded":0,"history":[]}
Response
application/json
{
  "success": true,
  "runtime": 77,
  "live_streams": [],
  "usage": {
    "max_passthrough_quota": 0,
    "max_transcoded_quota": 0,
    "usage_passthrough": 0,
    "usage_transcoded": 0,
    "history": []
  }
}

Create a live stream

Request

Query
api_tokenstringrequired

The api_token to authorize the request.

namestring

Give a name to your channel.

Default "no name"
locationstring

Location of the live server. Available values - us_central, us_east, us_west, eu, uk, au, jp, in, kr, tw, sg, br.

Default "us_central"
typestring

Type of live broadcast. Available values` passthrough - broadcast original input only, transcoded - broadcast original input and lower resolutions/bitrate.

Default "passthrough"
curl -i -X GET \
  'https://api.cincopa.com/v2/live.create.json?api_token=string&location=us_central&name=no%20name&type=passthrough'

Responses

Successful response.

Bodyapplication/json
successboolean

A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure

Example: true
runtimeinteger

The total time (milliseconds) taken by the server to process the request and return a response.

Example: 44
Response
application/json
{
  "success": true,
  "runtime": 44
}

Start a live stream

Request

Query
api_tokenstringrequired

The api_token to authorize the request.

liveidstringrequired

ID of the live stream, you can get it from live.list.

curl -i -X GET \
  'https://api.cincopa.com/v2/live.start.json?api_token=string&liveid=string'

Responses

Successful response.

Bodyapplication/json
successboolean

Indicates whether the request was successful. true for success, false for failure.

Example: true
runtimeinteger

How long the request took to process in second or milisecond.

Example: 77
statestring
Default "starting"
notestring
Example: "extra charge may apply - please contact your account manager for more info"
Response
application/json
{
  "success": true,
  "runtime": 77,
  "state": "starting",
  "note": "extra charge may apply - please contact your account manager for more info"
}

Stop a live stream

Request

Query
api_tokenstringrequired

The api_token to authorize the request.

liveidstringrequired

ID of the live stream, you can get it from live.list.

curl -i -X GET \
  'https://api.cincopa.com/v2/live.stop.json?api_token=string&liveid=string'

Responses

Successful response.

Bodyapplication/json
successboolean

Indicates whether the request was successful. true for success, false for failure.

Example: true
runtimeinteger

How long the request took to process in second or milisecond.

Example: 77
statestring
Default "stopped"
notestring
Example: "extra charge may apply - please contact your account manager for more info"
Response
application/json
{
  "success": true,
  "runtime": 77,
  "state": "stopped",
  "note": "extra charge may apply - please contact your account manager for more info"
}

Reset a live stream

Request

Query
api_tokenstringrequired

The api_token to authorize the request.

liveidstringrequired

ID of the live stream, you can get it from live.list.

curl -i -X GET \
  'https://api.cincopa.com/v2/live.reset.json?api_token=string&liveid=string'

Responses

Successful response.

Bodyapplication/json
successboolean

Indicates whether the request was successful. true for success, false for failure.

Example: true
runtimeinteger

How long the request took to process in second or milisecond.

Example: 77
statestring
Default "resetting"
notestring
Example: "extra charge may apply - please contact your account manager for more info"
Response
application/json
{
  "success": true,
  "runtime": 77,
  "state": "resetting",
  "note": "extra charge may apply - please contact your account manager for more info"
}

Delete a live stream

Request

Query
api_tokenstringrequired

The api_token to authorize the request.

liveidstringrequired

ID of the live stream, you can get it from live.list.

curl -i -X GET \
  'https://api.cincopa.com/v2/live.delete.json?api_token=string&liveid=string'

Responses

Successful response.

Bodyapplication/json
successboolean

A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure

Example: true
runtimeinteger

The total time (milliseconds) taken by the server to process the request and return a response.

Example: 44
Response
application/json
{
  "success": true,
  "runtime": 44
}