Training
Add a file
Initiates the process of uploading a file for AI training. This request generates a presigned URL, which must be used to upload the file via a PUT request. After the upload is complete, the file must be queued to begin processing. The system will then extract relevant content from the file for AI learning.
Supported File Types
Commonly supported formats include PDFs, text files, and other structured document types.
Important Notes:
- The uploaded file will not be processed until it is explicitly queued using the Queue a File endpoint.
- Training is subject to your account's plan limits. Once the limit is reached, additional files will not be processed.
- Files should be properly formatted and structured for optimal AI learning.
curl --request POST \
--url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/files \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"filename":"string"}'Path Parameters
- :accountID - REQUIRED[String]
The referenced account ID.
- :applicationID - REQUIRED[String]
The referenced application ID.
- :aiAgentID - REQUIRED[String]
The referenced AI Agent ID.
Add File Request - [Map]
The file to add to the AI Agent on an account.
Attributes
- filename - REQUIRED[String]
The name of the file uploaded to the system.
{
"filename": "string"
}Presigned File Response - [Map]
The detailed presigned 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.
- presignedURL - REQUIRED[String]
The presigned URL to use to access the file.
- 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.
{
"accountID": "string",
"aiAgentID": "string",
"createdAt": "string",
"fileID": "string",
"filename": "string",
"lastSyncAt": "string",
"presignedURL": "string",
"syncStatus": "string",
"updatedAt": "string"
}Errors
A common set of Error Responses can be found here.