Upload URLs

Add knowledge-base sources from one or more page URLs

POST /organizations/{organization_id}/projects/{project_id}/sources/urls

cURL

curl -X POST "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/sources/urls" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/docs/getting-started",
      "https://example.com/docs/pricing"
    ],
    "crawler": "crawl4ai"
  }'

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/sources/urls`,
  {
    method: "POST",
    headers: {
      "X-API-Key": process.env.BOTCADENCE_API_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      urls: [
        "https://example.com/docs/getting-started",
        "https://example.com/docs/pricing",
      ],
      crawler: "crawl4ai",
    }),
  }
);

import os
import requests

response = requests.post(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/sources/urls",
    headers={
        "X-API-Key": os.environ["BOTCADENCE_API_KEY"],
        "Content-Type": "application/json",
    },
    json={
        "urls": [
            "https://example.com/docs/getting-started",
            "https://example.com/docs/pricing",
        ],
        "crawler": "crawl4ai",
    },
)

201

{
  "status": "success",
  "message": "URLs added successfully",
  "data": null,
  "status_code": 201
}

Adds URL sources to the project knowledge base and queues crawling/indexing. Returns 201 Created.

Authentication

X-API-Key · string · required

Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id · string · required

Organization ID. Must match the API key.

project_id · string · required

Project ID. Must match the API key.

Body

urls · array · required

List of page URLs to ingest.

crawler · string · default: "crawl4ai"

Crawler engine: crawl4ai or apify.

Response

Success message confirming URLs were queued. data is typically null.

Errors

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized, or link quota exceeded.

cURL

curl -X POST "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/sources/urls" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/docs/getting-started",
      "https://example.com/docs/pricing"
    ],
    "crawler": "crawl4ai"
  }'

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/sources/urls`,
  {
    method: "POST",
    headers: {
      "X-API-Key": process.env.BOTCADENCE_API_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      urls: [
        "https://example.com/docs/getting-started",
        "https://example.com/docs/pricing",
      ],
      crawler: "crawl4ai",
    }),
  }
);

import os
import requests

response = requests.post(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/sources/urls",
    headers={
        "X-API-Key": os.environ["BOTCADENCE_API_KEY"],
        "Content-Type": "application/json",
    },
    json={
        "urls": [
            "https://example.com/docs/getting-started",
            "https://example.com/docs/pricing",
        ],
        "crawler": "crawl4ai",
    },
)

201

{
  "status": "success",
  "message": "URLs added successfully",
  "data": null,
  "status_code": 201
}