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

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 Functionalities	Endpoint	Purpose
Validate API Connection	`/ping.json`	This 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.json`	In 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 Functionalities	Endpoint	Purpose
Creating Galleries	`/gallery.create.json`	Establish 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.json`	Remove galleries that are no longer needed, ensuring your media library stays current.
Adding Items to Galleries	`/gallery.add_item.json`	Incorporate new media assets into existing galleries to enhance your content offerings.
Removing Items from Galleries	`/gallery.remove_item.json`	Manage your galleries by removing outdated or unwanted media assets.
Listing Galleries	`/gallery.list.json`	Retrieve a list of all galleries in your account for easy management and overview.
Retrieving Gallery Items	`/gallery.get_items.json`	Access detailed information about the media assets contained within a specific gallery.
Setting Master Media	`/gallery.set_master.json`	Designate 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 Functionalities	Endpoint	Purpose
List Assets	`/asset.list.json`	Get 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.json`	Updates 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.json`	Resync 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.json`	Delete 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.json`	Get 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.json`	Upload 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.json`	Use this method to get the Id of the uploaded asset when done.
Abort uploading process.	`/asset.upload_from_url_abort.json`	Use this method to abort an upload.

Operations

List of assets

Request

You can retrieve a list of all assets stored in your account, which can be added to any gallery as needed. To find specific assets, you can use a search query based on keywords. Alternatively, if you know the reference_id of an asset, you can use it to locate the asset directly. This makes it easier to access and manage assets efficiently.

Endpoint: GET /asset.list.json

URL: https://api.cincopa.com/v2/asset.list.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

searchstring

Used to search for a specific asset by text. This helps in filtering assets based on their textual metadata, such as names or descriptions.

Example: search=image

typestring

Determines the types of assets to return. Available values include video, image, audio, and other. If not specified, all types will be included by default.

Careful

If type is not specified, the API returns all asset types by default. This may lead to large datasets and longer response times.

Default "video,image,audio,other"

Example: type=video

ridstring

A unique identifier for an asset. It is used to locate a specific asset within the system by its Resource ID (RID).

Careful

The rid must be an exact match to locate the asset. Partial matches will not work.

Example: rid=A4KANh__rQ_m

reference_idstring

Used to search for an asset by its reference_id. This can be useful when cross-referencing with external databases or other systems.

Careful

If the reference_id does not exist, the API may return an empty response instead of an error

Example: reference_id=A4IA

tagstring

Allows searching for an asset based on its assigned tag. Special values include no-tag to find assets without any tags and any-tag to retrieve all assets regardless of their tag assignments.

Example: tag=image

detailsstring

Specifies extra metadata fields to return along with the asset. Available values include caption, description, music_tags, exif_tags, long_description, related_link_text, related_link_url, reference_id, and tags. Multiple values can be requested at once.

Default "caption, description, music_tags, exif_tags, long_description, related_link_text, related_link_url, reference_id"

Example: details=music_tags

pageinteger

Indicates the page number of the results to be retrieved. This is useful for paginating large datasets.

Careful

If an invalid or out-of-range page number is provided, the API may return an empty response.

Default 1

Example: page=2

items_per_pageinteger

Defines the number of items to be returned per page. Adjusting this value helps control the amount of data fetched in each request.

Default 50

Example: items_per_page=45

curl -i -X GET \
  'https://api.cincopa.com/v2/asset.list.json?api_token=AAAAtAURG&details=music_tags&items_per_page=45&page=2&reference_id=A4IA&rid=A4KANh__rQ_m&search=image&tag=image&type=video'

Responses

When the request to retrieve a list of assets is successful, the API returns a JSON response containing key details about the assets in your account. Below are the response parameters with their descriptions and examples.

Bodyapplication/json

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response.

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

itemsArray of arrays

A collection of multiple item objects. Each item represents an individual result returned by the API. The structure depends on the type of data requested.

Example: []

items_dataobject

An object containing metadata about the list of returned items. It provides information about pagination and the number of items retrieved.

Example: {"page":1,"items_per_page":50,"items_count":0,"pages_count":1}

Response

application/json

{
  "success": true,
  "runtime": 77,
  "items": [],
  "items_data": {
    "page": 1,
    "items_per_page": 50,
    "items_count": 0,
    "pages_count": 1
  }
}

List of tags

Request

This API retrieves the list of all tags associated with your account, helping categorize and organize assets efficiently. Tags allow you to group similar assets, making it easier to search, filter, and manage them within the system. Use this endpoint to fetch available tags for applying to new assets or filtering existing ones.

Endpoint: GET /asset.get_tags.json

URL: https://api.cincopa.com/v2/asset.get_tags.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

curl -i -X GET \
  'https://api.cincopa.com/v2/asset.get_tags.json?api_token=AAAAtAURG'

Responses

When the request to retrieve a list of tags is successful, the API returns a JSON response containing key details about the tags associated with your account. Below are the response parameters with their descriptions and examples.

Bodyapplication/json

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response.

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

tag_cloudobject

Displays the count of untagged assets and those with at least one tag, aiding in asset management and filtering.

Example: {"no-tag":999,"any-tag":99}

Response

application/json

{
  "success": true,
  "runtime": 77,
  "tag_cloud": {
    "no-tag": 999,
    "any-tag": 99
  }
}

Set asset metadata

Request

This API helps modify metadata attributes for a specific asset within your account. It helps you manage and update asset-related information, such as titles, descriptions, or custom fields, ensuring that media assets are well-organized and easily searchable.

Endpoint: POST/asset.set_meta.json

URL: https://api.cincopa.com/v2/asset.set_meta.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

ridstringrequired

A unique identifier for the asset whose metadata needs to be updated. If an incorrect or non-existent RID is provided, the request will not be processed.

Example: rid=A4KANh__rQ_m

captionstring

Defines a new title for the asset. If provided, it replaces the existing title associated with the asset.

Example: caption=photo gallery

descriptionstring

The description is a short summary of the asset. If included in the request, it will override the previous description.

Example: description=latest car images

long_descriptionstring

A detailed description of the asset. If specified, this long description will replace the existing one.

Example: long_description=All the latest release imported car images

related_link_textstring

The clickable text that serves as a hyperlink to related content.

Example: related_link_text=View Product Documentation

related_link_urlstring

The actual URL that the related_link_text points to.

Example: related_link_url=https://docs.example.com/product-guide

reference_idstring

A user-defined identifier assigned to an asset for custom tracking or integration purposes.

Example: reference_id=21T20

tagsstring

A comma-separated list of keywords to categorize the asset. If present in the request, these tags will replace the existing ones.

Example: tags=car, recentlaunch, imported car

video_thumb_secstring

Specifies the exact second in the video from which the thumbnail should be generated.

Example: video_thumb_sec=15

thumb_attached_ridstring

The reference ID of the image to be used as the asset’s thumbnail. When provided, it replaces the default or auto-generated thumbnail.

Careful

If the provided rid does not point to a valid image asset, the request may fail or revert to a default thumbnail.

Example: thumb_attached_rid=rid:12345ABCDE

curl -i -X POST \
  'https://api.cincopa.com/v2/asset.set_meta.json?api_token=AAAAtAURG&caption=photo%20gallery&description=latest%20car%20images&long_description=All%20the%20latest%20release%20imported%20car%20images&reference_id=21T20&related_link_text=View%20Product%20Documentation&related_link_url=https%3A%2F%2Fdocs.example.com%2Fproduct-guide&rid=A4KANh__rQ_m&tags=car%2C%20recentlaunch%2C%20imported%20car&thumb_attached_rid=rid%3A12345ABCDE&video_thumb_sec=15'

Responses

When the request to set the Asset Metadata is successful, the API returns a JSON response confirming the update. Below are the response parameters with their descriptions and examples.

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
}

Resync an asset

Request

This API initiates a process to check for missing versions of an asset and regenerate them if necessary. It is specifically used in scenarios where a gallery synchronization failure has occurred, ensuring that all asset versions remain updated and accessible. This method should only be used when an asset fails to sync properly and requires restoration.

Endpoint: POST /asset.resync.json

URL: https://api.cincopa.com/v2/asset.resync.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

ridstringrequired

A unique identifier for an asset used to locate a specific item. If invalid or missing, the API cannot process the request.

Example: rid=A4KANh__rQ_m

curl -i -X POST \
  'https://api.cincopa.com/v2/asset.resync.json?api_token=AAAAtAURG&rid=A4KANh__rQ_m'

Responses

When the request to fetch tags is successful, the API responds with a JSON object containing key details about the tags linked to your account. Below are the response parameters along with their descriptions and examples.

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
}

Delete an asset

Request

This API allows you to permanently delete an asset from your account. Once deleted, the asset is completely removed from the system, including any galleries it was part of. Use this endpoint carefully, as deleted assets cannot be recovered.

Endpoint: POST/asset.delete.json

URL: https://api.cincopa.com/v2/asset.delete.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

ridstringrequired

A unique identifier for the asset that needs to be deleted. The RID ensures that only the specified asset is removed from the system. If an invalid RID is provided, the request will not be processed.

Example: rid=A4KANh__rQ_m

curl -i -X POST \
  'https://api.cincopa.com/v2/asset.delete.json?api_token=AAAAtAURG&rid=A4KANh__rQ_m'

Responses

When the request to delete an asset is successful, the API returns a JSON response confirming the deletion. Below are the response parameters with their descriptions and examples.

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
}

Get upload URL

Request

This endpoint generates a temporary upload URL for adding assets to the library. Use this URL with an HTTP POST request to upload the asset. The asset can be added to a gallery or attached to another asset, such as setting a video poster. When attaching to another asset, a type name must be specified.

Endpoint: GET /asset.get_upload_url.json

URL: https://api.cincopa.com/v2/asset.get_upload_url.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

fidstring

A unique identifier for the gallery where the asset is stored. This is mandatory when adding an asset to a gallery. If an invalid or non-existent fid is provided, the request will not be processed.

Example: fid=A4KANh__rQ_m

ridstring

A unique identifier for the asset that requires a metadata update. If the provided rid is incorrect or does not exist, the API will reject the request, and the metadata update will not be processed.

Example: rid=AAAAtAURG

typestring

Defines the type of the attached asset, such as thumb, subtitle-en, or subtitle-en-us.

After uploading a thumbnail you'll need to call asset.set_meta.json with the same rid and pass the new image's rid as thumb_attached_rid to actually.

Default "thumb"

Example: type=subtitle-en-us

ttlstring

Specifies the duration (in seconds) for which the generated upload URL remains valid. Once the time expires, any attempt to use the URL will be rejected. If not provided, the URL remains valid indefinitely.

Example: ttl=46

sourceipstring

Defines the source IP address of the client allowed to use the generated upload URL. Any request from a different IP address will be rejected. This adds an extra layer of security by restricting access to a specific client machine.

Example: sourceip=192.168.1.100

curl -i -X GET \
  'https://api.cincopa.com/v2/asset.get_upload_url.json?api_token=AAAAtAURG&fid=A4KANh__rQ_m&rid=AAAAtAURG&sourceip=192.168.1.100&ttl=46&type=subtitle-en-us'

Responses

When an upload URL is successfully generated, the API returns a JSON response confirming the action. Below are the response parameters with corresponding descriptions and examples.

Bodyapplication/json

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response.

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

upload_urlstring(uri)

A temporary URL used to upload an asset. This URL should be accessed via an HTTP POST request within the valid timeframe. Modifying its structure may result in an upload failure.

Example: "https://mediaupload.cincopa.com/post.jpg?uid={UID}&d=AAAAcAAJFOAAAAAAAAtAURG&hash={HAASH}&addtofid={FID}&addtorid={ADD_TO_RID}:thumb"

Response

application/json

{
  "success": true,
  "runtime": 77,
  "upload_url": "https://mediaupload.cincopa.com/post.jpg?uid={UID}&d=AAAAcAAJFOAAAAAAAAtAURG&hash={HAASH}&addtofid={FID}&addtorid={ADD_TO_RID}:thumb"
}

Upload asset from URL

Request

This API endpoint allows you to upload an asset using a provided URL. The asset can either be added to a gallery or linked to another asset, such as a video poster. If attaching it to another asset, a type name must be specified.

Once the request is successful, the API returns a status ID. This ID can be used with asset.upload_from_url_get_status to track the upload progress and retrieve the asset's ID after completion.

Endpoint: POST /asset.upload_from_url.json

URL: https://api.cincopa.com/v2/asset.upload_from_url.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

inputstringrequired

The URL of the source asset to be uploaded. This is the location from which the API will fetch the asset.

Example: input=https://example.com/image.jpg

fidstring

A unique identifier for the gallery where the asset should be uploaded. This is mandatory when adding an asset to a gallery. If an invalid or non-existent fid is provided, the request will not be processed.

Example: fid=A4KANh__rQ_m

ridstring

A unique identifier for an asset when attaching it to another existing asset. If an invalid or non-existent rid is provided, the request will be rejected, and the attachment will not be processed. If specified, a type must also be provided.

Example: rid=AAAAtAURG

typestring

Defines the type of the attached asset. This is particularly important when associating an asset with another asset.

Default "thumb"

Example: type=thumb

curl -i -X POST \
  'https://api.cincopa.com/v2/asset.upload_from_url.json?api_token=AAAAtAURG&fid=A4KANh__rQ_m&input=https%3A%2F%2Fexample.com%2Fimage.jpg&rid=AAAAtAURG&type=thumb'

Responses

When an asset is successfully uploaded from a provided input URL, the API returns a JSON response confirming the action. Below are the response parameters with their descriptions and examples.

Bodyapplication/json

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response.

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

status_idstring

A unique identifier assigned to track the upload process. This ID can be used in subsequent API calls to check the status of the upload operation.

Store the status_id safely, as it is unique per upload request and required for tracking progress—losing it may require reinitiating the upload.

Example: "4dfdfdc39-2dfd-4df3c-82d7-b76sdfdcf2677"

Response

application/json

{
  "success": true,
  "runtime": 77,
  "status_id": "4dfdfdc39-2dfd-4df3c-82d7-b76sdfdcf2677"
}

Get upload status

Request

This API allows users to check the status of an asset upload request. When an asset is uploaded, the system assigns a unique status_id. This ID can be used to track the upload progress and determine whether the upload has been successfully completed.

To retrieve the upload status, users must provide a valid authentication key (api_token) along with the corresponding status_id. If the provided ID is incorrect or does not exist, the request will return an error.

Endpoint: GET /asset.upload_from_url_get_status.json

URL: https://api.cincopa.com/v2/asset.upload_from_url_get_status.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

status_idstringrequired

A unique identifier assigned to each asset upload request. This ID is returned when an asset is uploaded. It is required to track the progress of the upload and retrieve its final status. If an incorrect or non-existent status_id is provided, the request will fail.

Example: status_id=AAAAcAAJFOAAAAAAAAtAURG

curl -i -X GET \
  'https://api.cincopa.com/v2/asset.upload_from_url_get_status.json?api_token=AAAAtAURG&status_id=AAAAcAAJFOAAAAAAAAtAURG'

Responses

When an asset upload status request is made, the API returns a JSON response containing key details about the progress and outcome of the upload process. This response includes information such as the number of bytes uploaded, the total file size, the upload status, and whether the request was successful.

Below are the response parameters with their descriptions and examples.

Bodyapplication/json

progress_bytesstring

Indicates the number of bytes that have been uploaded so far. This helps track the progress of the upload in real time.

Example: 0

morestring

Provides additional information related to the upload process. This field may contain messages or metadata relevant to the request.

Example: "string"

residstring

A unique identifier assigned to the uploaded asset. This ID is essential for referencing the asset in future API calls.

Example: "AAAAcAAJFOAAAAAAAAtAURG"

debugstring

Contains debugging information, including timestamps and details about the request, which can help diagnose issues during the upload process.

Example: "2025-02-24T09:16:14.8562610-06:00 started... _bytesRecievedTotal=0 _bytesSendTotal=0 url=https://media"

file_size_bytesstring

Indicates the total size of the uploaded file in bytes. This value helps verify the expected file size against the actual upload progress.

Example: "62 byte"

statusstring

Represents the current upload status, which can be "inprogress" (ongoing), "completed" (successful), or "failed" (error occurred).

Example: "inprogress"

progressstring

Provides an upload progress indicator. The value can be used to determine how much of the upload is complete.

Example: 1

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

Response

application/json

{
  "progress_bytes": 0,
  "more": "string",
  "resid": "AAAAcAAJFOAAAAAAAAtAURG",
  "debug": "2025-02-24T09:16:14.8562610-06:00 started... _bytesRecievedTotal=0 _bytesSendTotal=0 url=https://media",
  "file_size_bytes": "62 byte",
  "status": "inprogress",
  "progress": 1,
  "success": true,
  "runtime": 77
}

Abort uploading process

Request

This API allows you to terminate an ongoing file upload. This is useful when an upload is no longer needed, was initiated by mistake, or is taking too long. Aborting an upload prevents unnecessary storage usage and system load. Once aborted, the upload process cannot be resumed, and any partially uploaded data will be discarded.

Endpoint: POST/asset.upload_from_url_abort.json

URL: https://api.cincopa.com/v2/asset.upload_from_url_abort.json

Query

api_tokenstringrequired

A unique key used for authentication. Must be a valid API key provided by the system. Without the valid api_token, the request will be rejected with a 403 Unauthorized error.

Example: api_token=AAAAtAURG

status_idstringrequired

Example: status_id=AAAAcAAJFOAAAAAAAAtAURG

curl -i -X POST \
  'https://api.cincopa.com/v2/asset.upload_from_url_abort.json?api_token=AAAAtAURG&status_id=AAAAcAAJFOAAAAAAAAtAURG'

Responses

When the upload process is successfully aborted, the API returns a JSON response confirming the action. Below are the response parameters along with their descriptions and examples.

Bodyapplication/json

successboolean

Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response.

Example: true

runtimeinteger

Specifies the total time taken to process the request, measured in milliseconds.

Example: 77

status_idstring

A unique identifier assigned to track the upload process. This ID can be used in subsequent API calls to check the status of the upload operation.

Store the status_id safely, as it is unique per upload request and required for tracking progress—losing it may require reinitiating the upload.

Example: "4dfdfdc39-2dfd-4df3c-82d7-b76sdfdcf2677"

Response

application/json

{
  "success": true,
  "runtime": 77,
  "status_id": "4dfdfdc39-2dfd-4df3c-82d7-b76sdfdcf2677"
}

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 Functionalities	Endpoint	Purpose
HTML iframe to manage gallery	`/upload.iframe`	Provides 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.json`	Generates 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 Functionalities	Endpoint	Purpose
Verify subdomain	`/portal.check.json`	Checks 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.json`	Renames a specified portal by providing the existing portal ID and the new desired name. This helps in organizing portals efficiently.
Remove subdomain	`/portal.remove.json`	Deletes a portal from the system. This operation is irreversible and permanently removes all associated data.
Save subdomain	`/portal.set.json`	Creates 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.json`	Retrieves 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 Functionalities	Endpoint	Purpose
List of webhooks	`/webhook.list.json`	Retrieves a list of all active webhooks associated with the account, including their configurations and callback URLs.
Create/update webhook	`/webhook.set.json`	Registers a new webhook by specifying a callback URL and event types to trigger notifications.
Create/update webhook to slack	`/webhook.set_slack.json`	Sets up a webhook that sends real-time event notifications directly to a Slack channel for instant updates.
Delete a webhook	`/webhhook.delete.json`	Deletes an existing webhook, stopping further event notifications and removing it from the system.

Operations

Live

Professional Live Video Streaming Service.

Operations

Getting Started (1.0.0)

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

General

Gallery

Assets

List of assets

Request

Responses

Was this helpful?

List of tags

Request

Responses

Was this helpful?

Set asset metadata

Request

Responses

Was this helpful?

Resync an asset

Request

Responses

Was this helpful?

Delete an asset

Request

Responses

Was this helpful?

Get upload URL

Request

Responses

Was this helpful?

Upload asset from URL

Request

Responses

Was this helpful?

Get upload status

Request

Responses

Was this helpful?

Abort uploading process

Request

Responses

Was this helpful?

Upload

Portal

Webhook

Live