Training

Add a website

Adds a website to the system and begins the training process immediately. The training uses the provided website URL to extract information for the AI Agent. For optimal results, it's recommended to provide a URL linking to a sitemap.xml, as this helps the system identify all the relevant links within the website. If no sitemap is available, the system will crawl any accessible links it finds on the site.

Important Notes:

Only links within the same domain (including subdomains) will be selected for training.
Ensure that the provided website URL is accessible and correctly formatted.
The training process is subject to your account's plan limit. Once the limit is reached, the training will stop.

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

curl --request POST \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/websites \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","url":"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 Website Request - [Map]

The website to add to the account.

Attributes

name - REQUIRED[String]
A user-friendly name for the website being added.
url - REQUIRED[String]
The URL of the website or sitemap that will be crawled. This URL will be used for training the AI Agent.

Add Website Request Shape

{
  "name": "string",
  "url": "string"
}

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.