sitegpt-ai Chatbot Links API
APIs to fetch internal links of any url and to add certain links to a particular chatbot.
APIs to fetch internal links of any url and to add certain links to a particular chatbot.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sitegpt-ai:sitegpt-ai-chatbot-links-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: SiteGPT API Collection Chatbot Links API
description: 'This collection contains the documentation of all the API endpoints.
## Getting started guide
To start using the SiteGPT APIs, you need to
- You must use a valid API Key to send requests to the API endpoints. You can get your API key from SiteGPT''s billing dashboard. If you don''t see it there, contact admin to generate one for you.
- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
## Authentication
SiteGPT uses API keys for authentication. You can generate a SiteGPT API key in the billing dashboard.
You must include an API key in each request to the Postman API with the Authorization request header.
Header Name : Authorization
Header Value : Bearer {{your-api-key}}
### Authentication error response
If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
## Need some help?
In case you have any questions, feel free to contact us.'
license:
name: SiteGPT Terms and Conditions
url: https://sitegpt.ai/terms
version: 1.0.0
contact:
name: Bhanu Teja P
email: bhanu@sitegpt.ai
url: mailto:bhanu@sitegpt.ai
servers:
- url: https://sitegpt.ai/api
security:
- bearerAuth: []
tags:
- name: Chatbot Links
x-displayName: Content & Training
description: APIs to fetch internal links of any url and to add certain links to a particular chatbot.
x-mint:
icon: book-open
paths:
/v0/chatbots/{chatbotId}/links:
parameters:
- schema:
type: string
name: chatbotId
in: path
required: true
description: Id of the chatbot
post:
tags:
- Chatbot Links
summary: Add Links to Chatbot (v0)
deprecated: true
description: '**⚠️ DEPRECATED**: This endpoint is deprecated and will be sunset on June 1, 2026.
Please migrate to the v1 API endpoint (`/v1/chatbots/{chatbotId}/links`) for:
- Advanced features (website crawling, sitemaps, YouTube)
- Better performance and reliability
- More granular control over content ingestion
---
Add a list of URLs to the chatbot. This is the simplified v0 endpoint for backward compatibility.
**Note:** The `urlType` field is optional and deprecated. ZENDESK and GITBOOK source types are no longer supported.
**Migration Guide**: See `/v1/chatbots/{chatbotId}/links` endpoint documentation.'
requestBody:
content:
application/json:
schema:
type: object
description: Request Body
properties:
links:
type: array
description: List of URLs to be added to the chatbot (max 1000 per request)
minItems: 1
maxItems: 1000
items:
type: object
properties:
url:
type: string
format: uri
description: URL to be added
urlType:
description: (DEPRECATED) Type of the URL. This field is accepted for backward compatibility but ignored. ZENDESK and GITBOOK are no longer supported.
enum:
- WEB
- ZENDESK
- GITBOOK
required:
- url
required:
- links
examples:
Request Body:
value:
links:
- url: https://sitegpt.ai
- url: https://sitegpt.ai/pricing
- url: https://sitegpt.ai/docs
description: Request body to add links to the chatbot
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
description: application/json
content:
application/json:
schema:
type: object
description: Success Response
properties:
success:
type: boolean
description: Indicates whether this is success response or error response
message:
type: string
description: Overall message regarding the operation performed
data:
type: object
description: Data returned from the server
examples:
Success:
value:
success: true
message: Added links to the chatbot successfully
data: {}
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Validation Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_ID_REQUIRED
message: chatbotId is required
details: null
Invalid Request Body:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: REQUEST_VALIDATION_FAILED
message: Request body is not valid
details:
- path:
- links
- 4
- urlType
message: Invalid enum value. Expected `WEB` | `ZENDESK` | `GITBOOK`, received `WE`
headers:
Content-Type:
schema:
type: string
description: application/json
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Authentication Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: API_KEY_NOT_VALID
message: Authorization header does not contain valid API key
details: null
headers:
Content-Type:
schema:
type: string
description: application/json
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Forbidden Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_ADD_LINKS_FORBIDDEN
message: You are not authorized to add links to this chatbot
details: null
Account Inactive Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: ACCOUNT_INACTIVE
message: This account has no active plan.
details: null
headers:
Content-Type:
schema:
type: string
description: application/json
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
description: application/json
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Not Found Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_OWNER_NOT_FOUND
message: Chatbot owner doesnot exist for the chatbot
details: null
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Method Not Allowed Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: REQUEST_METHOD_NOT_ALLOWED
message: PATCH request method is not allowed
details: null
headers:
Content-Type:
schema:
type: string
description: application/json
'429':
description: Too Many Requests - Quota Exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Links Limit Reached Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_LINKS_LIMIT_REACHED
message: You have reached your pages quota limit. Cannot add more links.
headers:
Content-Type:
schema:
type: string
description: application/json
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Server Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_ADD_LINKS_FAILED
message: Some technical error has occurred !!
details: null
headers:
Content-Type:
schema:
type: string
description: application/json
operationId: add-links-to-chatbot-v0
/v1/chatbots/{chatbotId}/links:
parameters:
- schema:
type: string
name: chatbotId
in: path
required: true
description: Id of the chatbot
post:
tags:
- Chatbot Links
summary: Add Content to Chatbot
description: 'Unified endpoint to add content to a chatbot. Supports multiple source types:
- **URLS_LIST**: Add a list of URLs directly
- **WEBSITE**: Crawl a website with configurable depth and filters
- **SITEMAP**: Extract URLs from an XML sitemap
- **YOUTUBE**: Add YouTube video or channel transcripts
This endpoint provides full control over crawling behavior, scraping options, and auto-sync configuration.'
requestBody:
required: true
description: Request body with source type and configuration
content:
application/json:
schema:
oneOf:
- type: object
description: Add URLs from a list
required:
- sourceType
- config
properties:
sourceType:
type: string
enum:
- URLS_LIST
config:
type: object
required:
- urls
properties:
urls:
type: array
minItems: 1
maxItems: 1000
items:
type: string
format: uri
description: List of URLs to add (max 1000)
scrapeOptions:
$ref: '#/components/schemas/ScrapeOptions'
syncFrequency:
$ref: '#/components/schemas/SyncFrequency'
- type: object
description: Crawl a website
required:
- sourceType
- config
properties:
sourceType:
type: string
enum:
- WEBSITE
config:
type: object
required:
- url
- maxLinks
properties:
url:
type: string
format: uri
description: Starting URL for the website crawl
recursionDepth:
type: integer
minimum: 1
maximum: 5
default: 3
description: How many levels deep to crawl (1-5)
maxLinks:
type: integer
minimum: 1
description: Maximum number of pages to scrape
includePaths:
type: array
items:
type: string
description: Only include URLs matching these path patterns
excludePaths:
type: array
items:
type: string
description: Exclude URLs matching these path patterns
allowedDomains:
type: array
items:
type: string
description: Allow crawling these additional domains
scrapeOptions:
$ref: '#/components/schemas/ScrapeOptions'
syncFrequency:
$ref: '#/components/schemas/SyncFrequency'
- type: object
description: Extract URLs from a sitemap
required:
- sourceType
- config
properties:
sourceType:
type: string
enum:
- SITEMAP
config:
type: object
required:
- url
- maxLinks
properties:
url:
type: string
format: uri
description: URL of the XML sitemap
maxLinks:
type: integer
minimum: 1
description: Maximum number of URLs to extract from sitemap
includePaths:
type: array
items:
type: string
description: Only include URLs matching these path patterns
excludePaths:
type: array
items:
type: string
description: Exclude URLs matching these path patterns
scrapeOptions:
$ref: '#/components/schemas/ScrapeOptions'
syncFrequency:
$ref: '#/components/schemas/SyncFrequency'
scanFrequency:
$ref: '#/components/schemas/SyncFrequency'
- type: object
description: Add YouTube video or channel
required:
- sourceType
- config
properties:
sourceType:
type: string
enum:
- YOUTUBE
config:
type: object
required:
- url
properties:
url:
type: string
format: uri
description: YouTube video or channel URL
syncFrequency:
$ref: '#/components/schemas/SyncFrequency'
examples:
URLS_LIST:
value:
sourceType: URLS_LIST
config:
urls:
- https://sitegpt.ai
- https://sitegpt.ai/pricing
- https://sitegpt.ai/docs
WEBSITE:
value:
sourceType: WEBSITE
config:
url: https://sitegpt.ai
recursionDepth: 3
maxLinks: 100
includePaths:
- /docs
- /blog
excludePaths:
- /admin
syncFrequency: WEEKLY
SITEMAP:
value:
sourceType: SITEMAP
config:
url: https://sitegpt.ai/sitemap.xml
maxLinks: 500
syncFrequency: DAILY
scanFrequency: DAILY
YOUTUBE:
value:
sourceType: YOUTUBE
config:
url: https://youtube.com/watch?v=dQw4w9WgXcQ
syncFrequency: NEVER
responses:
'200':
description: OK - Content added successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
data:
type: object
properties:
ingestJobId:
type: string
description: ID of the ingestion job created
documentsQueued:
type: integer
description: Number of documents queued for processing
examples:
Success:
value:
success: true
message: Added links to the chatbot successfully
data:
ingestJobId: job_abc123
documentsQueued: 5
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Validation Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: REQUEST_VALIDATION_FAILED
message: Request body is not valid
details:
- path:
- config
- recursionDepth
message: Number must be greater than or equal to 1
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Authentication Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: API_KEY_NOT_VALID
message: Authorization header does not contain valid API key
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Forbidden Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_ADD_LINKS_FORBIDDEN
message: You are not authorized to add links to this chatbot
Account Inactive Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: ACCOUNT_INACTIVE
message: This account has no active plan.
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Not Found Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_OWNER_NOT_FOUND
message: Chatbot owner does not exist for the chatbot
'429':
description: Too Many Requests - Quota Exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Quota Exceeded:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_LINKS_LIMIT_REACHED
message: 'You have reached your pages quota limit (500 pages). Current usage: 500 pages.'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Server Error:
value:
success: false
message: Failed to add links to the chatbot
data: null
error:
code: CHATBOT_ADD_LINKS_FAILED
message: Some technical error has occurred !!
operationId: add-content-to-chatbot-v1
components:
schemas:
ScrapeOptions:
title: ScrapeOptions
type: object
description: Options for web scraping
properties:
onlyMainContent:
type: boolean
default: true
description: When enabled, only the main content of the page is extracted, excluding headers, footers, sidebars, and navigation elements
includeSelectors:
type: array
items:
type: string
description: CSS selectors to include when scraping (e.g., "main", ".content")
excludeSelectors:
type: array
items:
type: string
description: CSS selectors to exclude when scraping (e.g., "footer", ".sidebar")
headers:
type: object
additionalProperties:
type: string
description: 'Custom HTTP headers to use when fetching pages (e.g., {"Authorization": "Bearer token"})'
SyncFrequency:
title: SyncFrequency
type: string
description: Frequency for automatic content re-sync (requires feature flag)
enum:
- NEVER
- DAILY
- WEEKLY
- MONTHLY
default: NEVER
ErrorResponse:
type: object
description: Error Response
properties:
success:
type: boolean
description: Indicates that this is error response
message:
type: string
description: Overall error message regarding the operation performed
data:
type:
- object
- 'null'
description: Data returned from the API. This will be `null` for errors
error:
type: object
description: Object with the error details
properties:
code:
type: string
description: Based on this error code, you can identify what is the error
message:
type: string
description: The message indicating the reason for the error
details:
type:
- array
- 'null'
description: More details on the error. Applicable only for Validation errors
items:
type: object
properties:
path:
type: array
description: Specifies the path in request body where error occurred. If the error field is nexted, then this array length will be more than 1.
items:
oneOf:
- type: string
description: Specifies the name of the field
- type: integer
description: Specifies the position in an array
message:
type: string
description: Reason for the error of the path mentioned before
securitySchemes:
bearerAuth:
type: http
scheme: bearer