Onna Platform API

Name: Onna Platform API
Brand: Onna Platform API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageDocument Managementoauth227 EndpointsREST

For Agents

Upload files and tickets into Onna workspaces, organise them with folders and custom fields, and authenticate using OAuth 2.0.

Install Jentic One Beta

Connect the Onna Platform API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Onna Platform API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Onna Platform API.

Create and manage workspaces that hold ingested resources

Organise content into nested folders inside a workspace

Upload files using the resumable tus protocol for large or unstable connections

GET STARTED

Start building with Onna Platform API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Onna Platform API, keeping it validated and agent-ready. Onna is a knowledge integration platform that ingests files, tickets, and other content from across an enterprise into a single, searchable workspace. The Platform API lets developers programmatically push resources into Onna using the resumable tus upload protocol, organise them into workspaces and folders, and attach custom fields for metadata. It is built for legal, compliance, and information governance teams who need to consolidate scattered enterprise data into a managed knowledge layer.

Use Cases

Patterns agents use Onna Platform API for, with concrete tasks.

★ Legal hold and ediscovery ingestion

Legal teams ingest custodian data from email, chat, and file shares into Onna so it can be searched and exported under a legal hold. The Platform API lets the ediscovery vendor or in-house tooling push files via tus uploads, attach matter-level custom fields, and organise everything into per-custodian folders. This replaces ad hoc data drops and gives ops a defensible chain of custody.

POST /workspaces to create a matter workspace, POST /folders for each custodian, then POST /resources/files with tus upload for each document.

Compliance archive for regulated communications

Financial services and healthcare firms must archive communications and documents in a tamper-evident store. Onna ingests content from chat tools, email, and ticketing systems, and the Platform API is the integration point for proprietary or in-house systems that the standard connectors do not cover. Custom fields let compliance teams tag policy, retention, and review status at ingest time.

Create a compliance workspace, define a custom field for retention class, then ingest each archived message as a ticket resource with the retention class set.

Knowledge consolidation across SaaS sprawl

Operations teams use Onna to bring together documents from many SaaS apps so internal teams can search one knowledge layer instead of ten. The Platform API is the way to integrate sources Onna does not have a native connector for, and to keep ingest running on a schedule. Most one-off connectors are built and shipped within a sprint.

List workspaces with GET /workspaces, pick the engineering workspace, create a folder per source, and ingest the source's exported files via tus uploads.

AI agent enterprise ingestion through Jentic

An AI agent that assembles a knowledge base for a downstream RAG system can call Onna through Jentic to push files without holding the OAuth token. The agent searches Jentic for the upload operation, loads the schema, and uses the tus endpoints to stream large files reliably. Jentic injects the OAuth credential at execution time so the secret never enters the agent context.

Search Jentic for 'upload file to onna', load the POST /resources/files operation, and execute the resumable tus upload for a single document into a target workspace.

Key Endpoints

27 endpoints — jentic publishes the only available openapi specification for onna platform api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/oauth/token

Exchange credentials for an OAuth access token

GET

/workspaces

List workspaces in the tenant

POST

/workspaces

Create a new workspace

POST

/folders

Create a folder in a workspace

POST

/resources/files

POST

/upload/{id}/tus

Start a resumable tus upload

POST

/customFields

Define a custom metadata field

POST

/oauth/token

Exchange credentials for an OAuth access token

GET

/workspaces

List workspaces in the tenant

POST

/workspaces

Create a new workspace

POST

/folders

Create a folder in a workspace

POST

/resources/files

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Onna uses OAuth 2.0 with refreshable access tokens. Jentic stores both the client credentials and the refresh token in the vault and handles the refresh transparently, which prevents stale-token errors and keeps the credential out of agent prompts and logs.

Intent-based discovery

Agents search Jentic with intents like 'upload file to onna' or 'create an onna workspace' and Jentic returns the matching operations with their input schemas, including the workspace onna_id and tus upload sequence, so the agent does not have to learn the resumable upload protocol from scratch.

Time to first call

Direct Onna integration: 1-2 weeks for OAuth, tus upload sequencing, custom field setup, and error handling. Through Jentic: under 1 hour to search, load the schema, and execute the first ingest.

FAQs

Specific to using Onna Platform API through Jentic.

Why is there no official OpenAPI spec for Onna Platform API?

Onna publishes its API documentation at dev.onna.com but does not ship a maintained OpenAPI specification on its own developer site. Jentic generates and maintains this spec so that AI agents and developers can call Onna via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Onna Platform API use?

Onna uses OAuth 2.0. The integration calls POST /oauth/token to exchange credentials for an access token and then includes that token on every other call. The account must be on an Enterprise plan and the calling user must have the Developer role assigned. Through Jentic, the OAuth credential is held in the vault and injected at execution time.

How do I upload large files into Onna?

Use the tus resumable upload protocol exposed at POST /upload/{id}/tus, then PUT and PATCH the same path to stream chunks. This is the recommended path for any file larger than a few MB and is robust against network drops. POST /resources/files is used to register the file as a resource against a workspace once the upload completes.

What are the rate limits for the Onna Platform API?

Onna does not publish a global rate limit in the OpenAPI spec. The platform applies per-tenant throttling and signals it through 429 responses, so integrations should back off on Retry-After. Bulk ingestion should use tus chunking and limit parallel uploads per workspace to avoid unnecessary throttling.

How do I ingest documents into Onna through Jentic?

Install the SDK with 'pip install jentic', search for the operation with the query 'upload file to onna', then load the POST /resources/files operation, and execute it with the workspace onna_id and file metadata. Jentic handles the OAuth refresh and the tus upload sequence.

Can I attach custom metadata to ingested resources?

Yes. Define the schema with POST /customFields and PATCH /workspaces/{onna_id}/customFields/{field_id}, then set the values on each resource at ingest time. This is how compliance teams tag matter, retention class, and review status without modifying the file payload.

Onna Platform API

Connect the Onna Platform API to your agent

Capabilities

Start building with Onna Platform API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs