Training

Gets a website

Retrieves detailed information about a specific website that has been linked to an AI Agent. This includes data about the website's training status and associated metadata. The request returns information about the website and its sync status, including the last time it was processed and the training progress.

Important Notes:

This API provides a snapshot of the website's status within the system.
To get information about all pages the system is aware of, use this endpoint to access a specific website's details, including the training state.
The training process may take time depending on the size and complexity of the website.

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

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

Website Response - [Map]

The detailed website information.

Attributes

accountID - REQUIRED[String]
The account ID associated with the website.
aiAgentID - REQUIRED[String]
The ID of the AI Agent the website is linked to.
createdAt - REQUIRED[String]
The timestamp when the website was added to the system.
lastSyncAt - OPTIONAL[String]
The timestamp when the website was last processed or synced.
name - REQUIRED[String]
The user-friendly name assigned to the website.
syncStatus - REQUIRED[String]
The sync status of the website [queued, in_progress, training, completed, failed].
updatedAt - REQUIRED[String]
The timestamp when the website's information was last updated.
url - REQUIRED[String]
The URL of the website that was added.
websiteID - REQUIRED[String]
The unique identifier for the website in the system.

Website Response Shape

{
  "accountID": "string",
  "aiAgentID": "string",
  "createdAt": "string",
  "lastSyncAt": "string",
  "name": "string",
  "syncStatus": "string",
  "updatedAt": "string",
  "url": "string",
  "websiteID": "string"
}

Errors

A common set of Error Responses can be found here.