Training

Gets a website

Retrieves all the trained website pages the system is aware of.

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

curl --request GET \
  --url http://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 the website is owned by.
aiAgentID - REQUIRED[String]
The AI agent the website is associated with.
createdAt - REQUIRED[String]
The date the website was added.
lastSyncAt - OPTIONAL[String]
The date the website was last processed.
name - REQUIRED[String]
An easy to remember label for this website.
syncStatus - REQUIRED[String]
Indicates the sync status of the website.
updatedAt - REQUIRED[String]
The date the website was last updated.
url - REQUIRED[String]
The website URL.
websiteID - REQUIRED[String]
The unique identifier for the website.

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.