Training

List all websites

Retrieves a list of all the websites associated with a specific AI Agent. The list contains details such as the website URL, sync status, and other relevant metadata. This API allows you to fetch all websites that have been linked and processed for training under a given AI Agent.

Important Notes:

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

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

curl --request GET \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/websites \
  --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.

Websites Response - [Map]

List of websites.

Attributes

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

Websites Response Shape

{
  "totalWebsites": 0,
  "websites": [
    {
      "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.