Cincopa connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Cincopa actions, such as "Get Asset Upload From URL Status", "Get Upload Iframe" and "Upload Asset From URL". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Cincopa, with input parameters and output schema.
CINCOPA_ASSET_UPLOAD_FROM_URLTool to upload a new asset directly from a provided external URL and receive a status ID for tracking. Use when you need to import media from a remote source and optionally specify a gallery or existing asset.
Input parameters
Unique identifier for the gallery where the asset should be uploaded. Required when adding to a gallery.
Unique identifier for an existing asset to attach this asset to. If provided, 'type' must also be specified.
Defines the type of the attached asset. Default is 'thumb'.
The URL of the source asset to be uploaded.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CINCOPA_ASSET_UPLOAD_FROM_URL_ABORTTool to abort an ongoing asset upload-in-progress by providing its status ID. Use when an upload is no longer needed, was initiated by mistake, or is taking too long.
Input parameters
Unique identifier of the in-progress upload to abort. This is returned when the upload was first initiated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CINCOPA_ASSET_UPLOAD_FROM_URL_GET_STATUSTool to check the status of an asset upload initiated via URL by its status ID. Use after calling 'Upload Asset From URL' to poll for completion.
Input parameters
Unique identifier for the upload process, returned by the initial 'Upload Asset From URL' call.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CINCOPA_GET_UPLOAD_IFRAMETool to get an upload iframe URL for embedding an upload widget. Use when you need to generate an HTML iframe for uploading media to a Cincopa gallery.
Input parameters
A unique identifier for a gallery. This parameter is used to specify the target gallery where the asset should be added.
A remote resource ID that serves as a reference to a remote object, such as an entity in a CRM or CMS. This can be used as an alternative to fid when linking assets to external systems.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CINCOPA_PINGTool to validate API connection. Use after obtaining a valid api_token to confirm connectivity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 Cincopa actions on Nagent, including "Get Asset Upload From URL Status", "Get Upload Iframe" and "Upload Asset From URL". Get Asset Upload From URL Status: Check the status of an asset upload initiated via URL by its status ID. Each action is listed on this page with its input parameters and its output.
Cincopa connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Asset Upload From URL Status takes 1 required input: status_id. It returns data, error and successful.