Cincopa API Support
License
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:
https://api.cincopa.com/v2/
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. |
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. |
Create a new multimedia gallery with customizable settings, styles, and content. This endpoint allows you to define gallery metadata, apply templates, clone existing galleries, or link to master galleries. Returns a unique fid (gallery ID) and an upload_url for adding media assets.
Endponit: POST/gallery.create.json
URL: https://api.cincopa.com/v2/gallery.create.json
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.
The desired name for the new gallery. Should be a non-empty string. Max 255 characters.
Description of the gallery's purpose or content. This is optional.
ID of a predefined template to apply the gallery's visual style.
template parameter should match one of Cincopa's available gallery templates. If omitted, a default template will be used.ID of another gallery to copy all settings from. This parameter supersedes the template parameter.
✅ Use template for predefined styles.
✅ Use copy_args to replicate complex configurations (e.g., permissions, metadata).
ID of a master gallery to link this gallery to (for centralized control)
master to synchronize settings across multiple galleries.https://api.cincopa.com/v2/gallery.create.json
curl -i -X POST \
'https://api.cincopa.com/v2/gallery.create.json?api_token=AAAAtAURG©_args=A6IA-RbWMvnr©_items=v4oA-RdqhMFlu&description=Contain%20travel%20photo&master=A4oA-RbdhMFlu&name=Photo%20Gallery&template=A4IA-RbWMFlu'When a gallery is successfully created, the API returns a JSON response containing key details about the newly generated gallery. Below are the response parameters with corresponding descriptions and examples.
Indicates whether the request was executed successfully. A value of true confirms a successful gallery creation, while false signifies failure.
Represents the time (in milliseconds) taken to process the request. This can be useful for monitoring performance and response times.
A unique identifier assigned to the newly created gallery. This ID is required for further operations, such as updating or retrieving the gallery details.
The direct URL where media files can be uploaded to the newly created gallery. This endpoint securely uploads files directly to the gallery. Expires after 24 hours.
Indicates gallery ownership. original = owned by the creator; shared = inherited from a master gallery.
An additional unique identifier related to the gallery, used for tracking gallery creation workflows. Rarely needed for integrations.
{ "success": true, "runtime": 77, "fid": "string", "upload_url": "https://mediaupload.cincopa.com/post.jpg?uid={USER_ID}&d=AAAAcAAJFOAAAAAAAAtAURG&hash={HASH}&addtofid={FID}", "claimed": "original", "spfid": "string", "workspace": "general" }
This endpoint allows you to update a gallery's metadata, including its title, description, tags, privacy settings, and custom properties. Keeping metadata up to date ensures accurate information, improves searchability, and enhances control over access permissions.
Endpoint: POST /gallery.set_meta.json
URL: https://api.cincopa.com/v2/gallery.set_meta.json
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.
The unique identifier of the gallery to be updated. It must match an existing gallery ID.
fid is provided, the API will not update any gallery metadata and may return an error.The new name for the gallery, with a maximum limit of 255 characters.
Detailed overview of the gallery's content and purpose (max 1,000 characters).
https://api.cincopa.com/v2/gallery.set_meta.json
curl -i -X POST \
'https://api.cincopa.com/v2/gallery.set_meta.json?api_token=AAAAAAURG&description=Contain%20travel%20photo&fid=21T20&name=Photo%20Gallery&tags=travel%2C%20adventure%2C%20nature%2C%20mountains%2C%20beaches'\'''{ "success": true, "runtime": 44 }
This API endpoint irreversibly deletes a gallery, including embedded media files, player settings, and analytics data. Once executed, the gallery cannot be recovered. Use this method cautiously, ensuring the galleryid is correct and necessary backups exist.
The request requires authentication via an API key with write permissions and supports both synchronous (immediate response) and asynchronous (callback URL) workflows.
Endpoint: POST/gallery.delete.json
https://api.cincopa.com/v2/gallery.delete.jsonA 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.
Unique identifier for the gallery to be deleted. Must be a valid gallery ID, ensuring the correct resource is targeted.
gallery_id before proceeding.GET /gallery/list endpoint to confirm the gallery_id matches the intended gallery.https://api.cincopa.com/v2/gallery.delete.json
curl -i -X POST \
'https://api.cincopa.com/v2/gallery.delete.json?api_token=AAAAtAURG&delete_assets=no&fid=AAAAtAURG'When a gallery is successfully deleted, the API returns a JSON response confirming the action. Below are the response parameters with corresponding descriptions and examples.
A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure
{ "success": true, "runtime": 44 }
This endpoint allows developers to add media files, such as images, videos, and audio, to an existing Cincopa gallery. This enables seamless media management, automates content updates, and integrates Cincopa with third-party applications.
The request requires authentication via an API key with write permissions and supports various media formats. Once executed, the media file is added to the specified gallery, making it immediately available for use.
Endpoint: POST /gallery.add_item.json
URL: https://api.cincopa.com/v2/gallery.add_item.json
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.
The unique identifier of the gallery to be updated. It must match an existing gallery ID.
fid is provided, the API will not update any gallery metadata and may return an error.A unique identifier for the asset being added. If adding multiple assets at once, provide a comma-separated list of asset IDs.
rid) are valid and exist in the system. If an invalid ID is provided, the request may fail partially or entirely.rid.https://api.cincopa.com/v2/gallery.add_item.json
curl -i -X POST \
'https://api.cincopa.com/v2/gallery.add_item.json?api_token=AAAAtAURG&fid=21T20&insert_position=top&rid=AAAAtAURG%2C%20meyAtAURG'When an asset is successfully added to a gallery, the API returns a JSON response confirming the action. Below are the response parameters with corresponding descriptions and examples.
A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure
{ "success": true, "runtime": 44 }
This API allows you to remove one or multiple assets from a gallery while giving you the choice to either keep them in other galleries or delete them permanently. If deleted, the assets will be removed from all galleries and the asset list. It helps in efficiently managing and organizing media files without unintended data loss.
Endpoint: POST /gallery.remove_item.json
URL: https://api.cincopa.com/v2/gallery.remove_item.json
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.
The unique identifier (FID) of the gallery from which the assets will be removed. If this parameter is missing or invalid, the request will fail.
A comma-separated list of asset IDs (RIDs) to be removed from the gallery. Each RID represents a unique asset within the system. If invalid or missing, the API will not process the request.
https://api.cincopa.com/v2/gallery.remove_item.json
curl -i -X POST \
'https://api.cincopa.com/v2/gallery.remove_item.json?api_token=AAAAtAURG&delete_assets=no&fid=21T20&rid=rid%3DAAAAtAURG%2CmeyAtAURG'{ "success": true, "runtime": 44 }
This API retrieves a list of galleries from a Cincopa account. You can search by captions, descriptions, IDs, and tags using keywords or filters. It supports pagination to control the number of results per page.
Endpoint: GET /gallery.list.json
URL: https://api.cincopa.com/v2/gallery.list.json
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.
Search for the term in all fields including caption, description, ID, tags etc. Use 'caption=whatever' or 'description=whatever' to do an exact term search.
Specifies which page of results to fetch. The minimum is 1. If the requested page exceeds the total number of pages, no results will be returned.
Defines how many galleries are shown per page. The minimum is 1, and the maximum is 100. If a higher value is requested, it is capped at 100.
This allows you to filter galleries by specific tags using a comma-separated list. You can also exclude certain tags.
filter_tags=tag1,tag2 to show galleries that contain either tag1 or tag2. Use filter_tags=-tag1 to exclude galleries with tag1 and display all others. Separate multiple tags with commas. Add a minus (-) before a tag to exclude it. https://api.cincopa.com/v2/gallery.list.json
curl -i -X GET \
'https://api.cincopa.com/v2/gallery.list.json?api_token=AAAAtAURG&filter_tags=car%2Ctruck&items_per_page=45&page=2&search=A4KANh__rQ_m'When a list of galleries is successfully retrieved, the API returns a JSON response containing key details about the galleries and related information. Below are the response parameters with corresponding descriptions and examples.
Indicates whether the request was successful. true for success, false for failure.
This contains the workspace associated with the request. It is generally used to indicate the workspace or environment the request was made in.
This is an array of galleries returned by the API, containing detailed information for each gallery.
This object contains information about the tags related to the galleries.
{ "success": true, "runtime": 15, "workspace": "", "galleries": [ { … } ], "tag_cloud": { "notags": 15, "master-gallery": 35 }, "items_data": { "page": 1, "items_per_page": 50, "items_count": 435, "page_count": 9 } }
This API retrieves all items from a specified gallery, including metadata and media URLs. It enables efficient access to gallery content while allowing customization of the metadata returned. Pagination is supported to manage large datasets effectively.
Endpoint: GET /gallery.get_items.json
URL: https://api.cincopa.com/v2/gallery.get_items.json
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.
The unique identifier (FID) of the gallery from which gallery's items should be retrieved.
Defines the metadata fields to include in the response, such as captions, descriptions, tags, and reference IDs. If not specified, default fields like caption, description, and music tags are included.
https://api.cincopa.com/v2/gallery.get_items.json
curl -i -X GET \
'https://api.cincopa.com/v2/gallery.get_items.json?api_token=AAAAtAURG&details=caption%2Cdescription&fid=21T20&items_per_page=45&page=1'When the request to retrieve gallery items is successful, the API responds with a JSON object containing detailed information about the items within the gallery. This response includes essential metadata, such as item identifiers, pagination details, and relevant attributes. Below are the response parameters with their descriptions and examples
Indicates whether the request was successful. true for success, false for failure. Always true for a 200 response.
The URL where the file can be uploaded or accessed. Always a valid URI format.
Specifies whether the file is the original or a modified version. Always either "original" or a predefined string.
An additional unique ID used for tracking or reference. Always a non-empty string.
{ "success": true, "runtime": 77, "fid": "string", "upload_url": "https://mediaupload.cincopa.com/post.jpg?uid={USER_ID}&d=AAAAcAAJFOAAAAAAAAtAURG&hash={HASH}&addtofid={FID}", "claimed": "original", "spfid": "string", "folder": { "items": [], "items_data": { … } } }
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.
The unique identifier (FID) of the gallery where the master template should be applied. If this value is missing or invalid, the request will not be processed.
https://api.cincopa.com/v2/gallery.set_master.json
curl -i -X POST \
'https://api.cincopa.com/v2/gallery.set_master.json?api_token=AAAAtAURG&fid=21T20&master=21T20'When a request is successfully processed, the API returns a JSON response containing key details about the outcome. Below are the response parameters with their descriptions and examples
A flag indicating the success of the request. True means the request was processed successfully, while false indicates failure
{ "success": true, "runtime": 44 }
This API allows users to generate a downloadable link for a zip file containing all items in a gallery. By using this endpoint, users can easily retrieve and share a single download link to access all gallery contents.
Endpoint: GET /gallery.download.json
URL: https://api.cincopa.com/v2/gallery.download.json
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.
The unique identifier (FID) of the gallery from which the files should be downloaded. If this value is missing or invalid, the request will fail.
https://api.cincopa.com/v2/gallery.download.json
curl -i -X GET \
'https://api.cincopa.com/v2/gallery.download.json?api_token=AAAAtAURG&fid=21T20&type=original'{ "success": true, "runtime": 77, "download_link": "https://www.cincopa.com/media-platform/runtime/download.aspx?fid={FID}&type={TYPE}&auth={AUTH}" }
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. |
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. |
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. |
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. |