Skip to main content

Data API

Use the BotDojo API when you want to push documents directly from your own applications or pipelines. API-driven uploads follow the same rules as integrations and scrapers—every file lands in your project’s document store with metadata that indexes can consume.

When to Use the API​

  • Automate uploads from internal systems that do not yet have a packaged integration.
  • Stream files generated by scheduled jobs (reports, transcripts, exports) into a project folder.
  • Attach metadata alongside the content so downstream flows can filter by attributes like customer ID or data source.

Core Workflow​

  1. Authenticate with a project-scoped API key.
  2. Call the Upload File endpoint with the destination folder, document bytes, and optional metadata payload.
  3. Monitor the response for the new document ID and version.
  4. (Optional) Trigger an index update if the folder feeds an index that does not auto-update.

Uploads created through the API appear in Data → Documents with the same metadata editing and version management tools as any other document. They also inherit index filters, auto-update logic, and session file handling.

Best Practices​

  • Generate stable logical paths (e.g., /customers/acme/contracts/2024-04.pdf) so reruns update the same document instead of creating duplicates.
  • Include meaningful metadata (department, record type, identifiers) to power retrieval filters.
  • Batch uploads when sending large numbers of files to reduce network chatter.
  • Pair the API with custom chunker flows if your documents need preprocessing before embedding.

For a full list of API routes and request examples, see the BotDojo API reference.