Integrations

Upload API

Use the knowledge Upload API to send files directly into the Calypso RAG indexing pipeline with a project API key.

What the Upload API is for

The Upload API turns knowledge ingestion into an automatable workflow. Use it when your source material is produced by another system and should not be uploaded manually through the UI.

Core flow

The upload path is:

  1. send a file with a project API key
  2. receive a file and task identifier
  3. poll status until indexing settles

What to document clearly

The docs for this surface should explain:

  • the upload endpoint
  • bearer-token authorization with a project API key
  • multipart/form-data
  • optional metadata and idempotency usage
  • the difference between accepted and searchable

Operational reality

A successful upload response does not mean the file is immediately retrievable. It means:

  • the file was accepted
  • storage and indexing work were queued

That distinction is critical for reliable troubleshooting.

Good use cases

  • syncing policy documents from another system
  • automating uploads from a content pipeline
  • seeding a new workspace with trusted material

When to avoid this path

If a human is still reviewing source quality manually, the Knowledge UI may be the better first step.