Knowledge Base Ingestion API
At Eleplan, the Project Ingestion API allows developers and users to securely send notes and documents directly into their Eleplan environment. This feature enables streamlined data ingestion through a custom-generated endpoint, providing both flexibility and control over how information enters your account.
Overview
The Project Ingestion API offers a way to upload notes or documents programmatically using a unique ingestion link and bearer token. Once generated, this link serves as a dedicated endpoint where data can be posted, allowing information to be quickly processed and stored within Eleplan.
The API operates in two modes—Test and Live—each serving different purposes for validation and production use.
- Test Mode: Performs a dry run to validate data and simulate processing without creating or storing content.
- Live Mode: Creates notes, stores files, and queues OCR-eligible documents for processing.
Link and Authentication
Each project can generate a unique ingestion link and authentication token. These credentials are required to interact with the API.
Unique Link
You can generate a custom endpoint from within Eleplan and configure optional usage limits such as expiration time or number of allowed requests. Only the ingestion URL and bearer token are needed to begin sending data.
Authentication
The ingestion API uses Bearer token authentication to ensure secure access. Tokens should be rotated immediately if exposed. A derived fallback token remains valid until a new token is explicitly generated.
Fields and Parameters
The following fields define how data should be structured when sent to the ingestion endpoint:
Field | Type | Description |
|---|---|---|
mode | string | Defines whether the request runs in |
items | array\<note\> | Contains one or more notes with fields such as |
files | array\<file\> | Accepts multiple file uploads in a single request. |
file | object | Allows a single legacy file object for backward compatibility. |
file.data_url | string | Base64-encoded data in the |
file.base64 | string | Raw Base64 alternative to |
file.kb_access | boolean | Forces Knowledge Base processing (defaults to true for OCR-supported files). |
Result Statuses
When a request is processed, the API returns one of several statuses to indicate its outcome:
Status | Type | Meaning |
|---|---|---|
would_create / would_create_file | preview | Test mode only – validates input without storing data. |
created / created_file | success | The note or file was successfully created or stored. |
queued_file | success | The file was stored and queued for processing (e.g., OCR). |
duplicate / duplicate_file | noop | The item already exists and was skipped to prevent duplication. |
error / error_file | error | A validation or storage issue occurred for the affected item. |
Limits and Performance
The Project Ingestion API supports files up to 25 MB in size.
Requests are rate-limited to ensure consistent performance and reliability:
- Maximum Requests per Second: 10
- Maximum Concurrent Requests: 100
This means up to 10 requests can be made every second, with a maximum of 100 active in-flight requests at any given time.
Security and Data Handling
The API is designed with idempotency and reliability in mind:
- Idempotency prevents duplicate data creation by verifying unique identifiers such as external IDs or content hashes.
- Partial failures are handled gracefully—invalid files are skipped, while valid items continue processing.
- All data submitted is protected through the same encryption standards that apply across Eleplan.
By using the Project Ingestion API, developers and users can securely and efficiently send data into Eleplan while maintaining full control over how information is validated, stored, and processed. If you need assistance generating your ingestion link or token, please contact our support team.
Updated on: 15/10/2025
Thank you!