NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
ASIN Data API connects to a Nagent workspace with an API key. Once it is connected, agents can call 6 ASIN Data API actions, such as "Get Collection Details", "List Collection Requests" and "List Destinations". 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 ASIN Data API, with input parameters and output schema.
ASIN_DATA_API_CLEAR_COLLECTION_REQUESTSDelete multiple requests from a collection by their IDs using the bulk delete endpoint. Use this tool when you need to remove a selected set of request entries from an existing collection. Note: Requests can only be deleted when the collection is not running.
Input parameters
Array of request ID strings to delete. Use LIST_COLLECTION_REQUESTS to get valid request IDs for a collection.
Unique identifier of the collection to clear requests from. Use LIST_COLLECTIONS to get valid collection IDs.
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
ASIN_DATA_API_DELETE_DESTINATIONDelete a destination from your account. Use this when you need to remove a destination that is no longer needed.
Input parameters
The unique identifier of the destination to delete. Can be obtained from the List Destinations action.
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
ASIN_DATA_API_GET_COLLECTIONGet details of a specific collection including status and request counts. Use when you need to check collection configuration, operational status, or aggregate statistics.
Input parameters
Unique identifier of the collection to retrieve. Can be obtained from the List Collections action.
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
ASIN_DATA_API_LIST_COLLECTION_REQUESTSList all requests in a Collection (paginated). Use to retrieve and paginate through all requests added to a specific collection. Returns up to 1000 requests per page with pagination info.
Input parameters
Page number for pagination (starts at 1). Each page returns up to 1000 requests.
Unique identifier of the collection whose requests are to be listed. Can be obtained from the List Collections action.
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
ASIN_DATA_API_LIST_DESTINATIONSList all destinations configured on your account. Use to retrieve and filter destination configurations for data export. Maximum 50 destinations allowed per account. Returns 10 destinations per page with pagination support.
Input parameters
Page number for pagination (starts at 1). Each page returns up to 10 destinations.
Sort criteria for destinations.
Filter destinations by name. Only destinations matching this search term will be returned.
Sort order for destinations.
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
ASIN_DATA_API_UPDATE_DESTINATIONUpdate an existing destination's configuration. Use to modify cloud storage settings, change the destination name, or enable/disable a destination. Only include fields you want to update.
Input parameters
New name for the destination.
Whether the destination should be enabled (true) or disabled (false).
Alibaba Cloud OSS region ID.
The unique identifier of the destination to update. Can be obtained from List Destinations action.
Google Cloud Storage access key for GCS authentication.
Google Cloud Storage secret key for GCS authentication.
Alibaba Cloud OSS access key for OSS authentication.
Alibaba Cloud OSS secret key for OSS authentication.
AWS S3 bucket name for S3-type destinations.
Path prefix within the S3 bucket where files will be stored.
Google Cloud Storage bucket name for GCS-type destinations.
Path prefix within the GCS bucket.
Alibaba Cloud OSS bucket name for OSS-type destinations.
Path prefix within the OSS bucket.
AWS access key ID for S3 authentication.
Azure storage account key for Azure authentication.
Path prefix within the Azure container.
Azure storage account name for Azure-type destinations.
Azure container name where files will be stored.
AWS secret access key for S3 authentication.
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 6 ASIN Data API actions on Nagent, including "Get Collection Details", "List Collection Requests" and "List Destinations". Get Collection Details: Get details of a specific collection including status and request counts. Each action is listed on this page with its input parameters and its output.
ASIN Data API 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 Collection Details takes 1 required input: collection_id. It returns data, error and successful.