Get source

Retrieve a single knowledge-base source by ID

GET /organizations/{organization_id}/projects/{project_id}/sources/{source_id}

cURL

curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/sources/SOURCE_ID" \
  -H "X-API-Key: bot_live_YOUR_KEY"

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/sources/${sourceId}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/sources/{source_id}",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
)

200

{
  "status": "success",
  "message": "Document retrieved successfully",
  "data": {
    "_id": "665f50000000000000000001",
    "name": "faq.pdf",
    "source_type": "files",
    "sync_status": "success",
    "file_size": 204800,
    "file_type": "application/pdf",
    "s3_key": "indexing/projects/PROJECT_ID/faq.pdf",
    "project_id": "PROJECT_ID",
    "organization_id": "ORG_ID",
    "created_at": "2026-07-21T10:00:00Z",
    "updated_at": "2026-07-21T10:05:00Z"
  },
  "status_code": 200
}

Returns one knowledge-base source (file, URL, or domain document).

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.

source_id · string · required

Source / document ID.

Response

Returns the source object (name, source_type, sync_status, file metadata, crawl metadata, timestamps).

Errors

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

404 · Not Found

Source not found.

cURL

curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/sources/SOURCE_ID" \
  -H "X-API-Key: bot_live_YOUR_KEY"

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/sources/${sourceId}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/sources/{source_id}",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
)

200

{
  "status": "success",
  "message": "Document retrieved successfully",
  "data": {
    "_id": "665f50000000000000000001",
    "name": "faq.pdf",
    "source_type": "files",
    "sync_status": "success",
    "file_size": 204800,
    "file_type": "application/pdf",
    "s3_key": "indexing/projects/PROJECT_ID/faq.pdf",
    "project_id": "PROJECT_ID",
    "organization_id": "ORG_ID",
    "created_at": "2026-07-21T10:00:00Z",
    "updated_at": "2026-07-21T10:05:00Z"
  },
  "status_code": 200
}