Training

List all files

Retrieves a list of all files that have been submitted for training with the AI Agent. This includes file metadata, processing statuses, and timestamps for each file.

Important Notes:

This API is useful for retrieving an overview of all the files linked to an AI Agent.
The sync status provides insights into the processing state of each file.
Files will be trained up to the limit defined by the account's plan.

GET/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/files

curl --request GET \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/files \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Path Parameters

:accountID - REQUIRED[String]
The referenced account ID.
:applicationID - REQUIRED[String]
The referenced application ID.
:aiAgentID - REQUIRED[String]
The referenced AI Agent ID.

Files Response - [Map]

List of files.

Attributes

files - REQUIRED[Array]
The list of files.
List Contents (files)- type of [Map]
- files[0].accountID - REQUIRED[String]
  The account ID associated with the file.
- files[0].aiAgentID - REQUIRED[String]
  The ID of the AI Agent the file is linked to.
- files[0].createdAt - REQUIRED[String]
  The timestamp when the file was added to the system.
- files[0].fileID - REQUIRED[String]
  The unique identifier for the file in the system.
- files[0].filename - REQUIRED[String]
  The original name of the uploaded.
- files[0].lastSyncAt - OPTIONAL[String]
  The timestamp when the file was last processed or synced.
- files[0].syncStatus - REQUIRED[String]
  The sync status of the file [initializing, queued, in_progress, training, completed, failed].
- files[0].updatedAt - REQUIRED[String]
  The timestamp when the file's information was last updated.
totalFiles - REQUIRED[Integer]
The total number of files in the list.

Files Response Shape

{
  "files": [
    {
      "accountID": "string",
      "aiAgentID": "string",
      "createdAt": "string",
      "fileID": "string",
      "filename": "string",
      "lastSyncAt": "string",
      "syncStatus": "string",
      "updatedAt": "string"
    }
  ],
  "totalFiles": 0
}

Errors

A common set of Error Responses can be found here.