Training

Gets a file

Fetches details about a previously submitted file used for training the AI Agent. This includes file metadata, processing status, and timestamps for synchronization.

Important Notes:

This API provides a snapshot of the file's status within the system.
The training process may take time depending on the size and complexity of the file.

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

curl --request GET \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/files/:fileID \
  --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.
:fileID - REQUIRED[String]
The referenced file ID.

File Response - [Map]

The detailed file information.

Attributes

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

File Response Shape

{
  "accountID": "string",
  "aiAgentID": "string",
  "createdAt": "string",
  "fileID": "string",
  "filename": "string",
  "lastSyncAt": "string",
  "syncStatus": "string",
  "updatedAt": "string"
}

Errors

A common set of Error Responses can be found here.