Chatbot Websites

Process Sitemap

Submit a sitemap URL to discover and train pages. The sitemap is parsed and all discovered URLs are crawled.

NOTE: Runs in the background. Poll websites.get for page counts per status.

post/chatbots/{chatbot_id}/websites/sitemap

Request

Base URL
https://app.boei.help/api/v1
Auth
HTTP bearer

Request body

urlstring required

The sitemap URL.

namestring nullable

Optional display name. Auto-generated from URL if omitted.

include_pathsstring nullable

Comma-separated paths to include.

exclude_pathsstring nullable

Comma-separated paths to exclude.

Example request

{
  "url": "https://example.com/sitemap.xml",
  "name": "My Sitemap",
  "include_paths": "/docs,/blog",
  "exclude_paths": "/admin,/login"
}

Response

job_idstring

status_urlstring

messagestring

Example response

{
  "website": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Sitemap example.com",
    "url": "https://example.com/sitemap.xml",
    "type": "sitemap",
    "status": "crawling",
    "progress": 0
  },
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status_url": "https://app.boei.help/api/v1/chatbots/8a832d1b-0f49-47f6-a05f-0b65b91d2107/websites/550e8400-e29b-41d4-a716-446655440000",
  "message": "Sitemap processing started"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.