Training

Retrain a website

If the content of your website has changed, this API allows you to manually retrain the AI Agent with the updated content. The retraining process depends on whether the website provides a sitemap.xml file:

  • If a sitemap.xml is available, retraining will use the last modified date as specified in the sitemap for faster retraining.
  • If the website does not provide a sitemap.xml, you will need to retrain individual pages using a separate retrain pages API.
  • Retraining may take some time depending on the size and complexity of the website.
PUT/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/websites/:websiteID/retrain
Click to copy
curl --request PUT \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents/:aiAgentID/websites/:websiteID/retrain \
  --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.

Response

Indicates the request was successful. Returns a status code of 204 with no content returned in the response body.

Errors

A common set of Error Responses can be found here.