Install Jentic One Beta

Connect the API reference to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the API reference, 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://jentic.com/install.sh?src=apis&api=%2Fapis%2Finstabase.com%2Finstabase" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Finstabase.com%2Finstabase" | 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 API reference API.

Create a batch, upload files to it, and list or remove its files before processing

Upload large documents in parts through a multipart session, then commit or abort it

Run an automation app by app_name or app_id, or run a deployment by its deployment id, against a batch_id or input_dir

Poll a run's status and fetch its results with include_confidence_scores, include_validation_results, and include_source_info

GET STARTED

Start building with API reference API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use API reference API for, with concrete tasks.

★ Document extraction agent through Jentic

An AI agent connected through Jentic takes a set of documents, creates an Instabase batch, uploads each file, and runs the team's deployment on it. It polls the run status, then fetches the results with confidence scores so low-confidence fields can be flagged for a person to check. The bearer token stays in your own Jentic One instance, not in the agent's context.

Call POST /v2/batches with name 'march-invoices', upload each PDF with PUT /v2/batches/{batch_id}/files/{filename}, run POST /v2/apps/deployments/{deployment-id}/runs with the batch_id, then poll GET /v2/apps/runs/{run_id} and fetch GET /v2/apps/runs/{run_id}/results with include_confidence_scores true

Large file ingestion

Scanned contracts and statement archives can be too large for a single upload. Start a multipart session with the batch_id, filename, and file_size, upload each part by number, then commit the session with action commit, or abort it if something fails. The file then sits in the batch ready for a run.

Call POST /v2/batches/multipart-upload with batch_id, filename 'archive.pdf', and file_size, PUT each part to /v2/batches/multipart-upload/sessions/{session_id}/parts/{part_num}, then POST /v2/batches/multipart-upload/sessions/{session_id} with action 'commit' and the parts list

Run monitoring and cleanup

Operations teams list runs by app_name, deployment_id, status, or a timestamp range to find failures, then inspect each run's status. When a run is no longer needed, deleting it can also remove its input, output, logs, and database data through the delete_input, delete_output, delete_logs, and delete_db_data flags.

Call GET /v2/apps/runs with deployment_id 'dep_123' and from_timestamp set to 24 hours ago, then report the id and status of each run that did not complete

Workspace secrets for deployments

Deployments that call other systems need credentials. The secrets operations store a value under an alias, describe it, and limit which workspaces may use it through allowed_workspaces_type of ALL, SOME, or NONE with an allowed_workspaces list, so the value is set once and referenced by alias.

Call POST /v2/aihub/secrets with alias 'erp-token', the value, and allowed_workspaces_type 'SOME' with allowed_workspaces ['finance']

Key Endpoints

27 endpoints — the instabase ai hub api runs instabase automation apps over your documents and returns the extracted results.

METHOD

PATH

DESCRIPTION

POST

/v2/batches

Create a batch

PUT

/v2/batches/{batch_id}/files/{filename}

Upload a file to a batch

POST

/v2/apps/deployments/{deployment-id}/runs

Run a deployment

POST

/v2/apps/runs

Run an app

GET

/v2/apps/runs/{run_id}

Get run status

GET

/v2/apps/runs/{run_id}/results

Get run results

GET

/v2/files/{path}

Read a file

POST

/v2/batches

Create a batch

PUT

/v2/batches/{batch_id}/files/{filename}

Upload a file to a batch

POST

/v2/apps/deployments/{deployment-id}/runs

Run a deployment

POST

/v2/apps/runs

Run an app

GET

/v2/apps/runs/{run_id}

Get run status

GET

/v2/apps/runs/{run_id}/results

Get run results

GET

/v2/files/{path}

Read a file

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring Instabase by hand means handling its bearer token and IB-Context header, sequencing batch uploads or multipart sessions, and polling runs before reading paginated results. Through Jentic you install once, import Instabase from the API Directory, store the token once, and your agent calls it.

Permission scoping

Instabase puts the deployment, run, and batch ids in the URL path (/v2/apps/deployments/{deployment-id}/runs), so a rule can pin your agent to one deployment and the operations you pick. You choose the operations it may call, so destructive ones like run deletion or secret updates are not included unless you add them.

Credential isolation

Your Instabase token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'run a document extraction app' or 'get Instabase run results', and Jentic returns the matching Instabase operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using API reference API through Jentic.

Is there an Instabase MCP server?

You don't need an MCP server to give your agent Instabase. Jentic connects it directly from the API Directory: import it, store your token once, and your agent calls it. The agent finds the batch, run, or file operation it needs on demand, so its context is not filled with tool definitions it never uses.

Can I limit what my agent is allowed to do with the Instabase API?

Yes. Write a rule that allows only POST /v2/apps/deployments/{deployment-id}/runs for your invoice deployment's id, plus GET /v2/apps/runs/{run_id} and GET /v2/apps/runs/{run_id}/results. The agent can start that one deployment and read what it produced, but it cannot touch secrets, delete runs, or write to file storage, and every call it makes is logged.

What authentication does the Instabase API use?

Per its OpenAPI spec, the Instabase AI Hub API uses HTTP bearer authentication: send your token in the `Authorization` header as `Bearer <token>`. Most operations also accept an optional `IB-Context` header, typically your organization ID, which sets the context that run inputs and outputs are validated against. Through Jentic, the token is stored encrypted by your own Jentic One instance and injected when each call runs.

How do I get all the results of a large Instabase run?

GET /v2/apps/runs/{run_id}/results is paginated. Check the has_more field in each response and pass file_offset on the next request to continue from where the last page ended, until has_more is false.

What are the rate limits for the Instabase API?

The OpenAPI spec does not specify rate limits; check https://docs.instabase.com for current limits.

Should I run an Instabase app or a deployment?

The spec recommends running a deployment over running an app directly. POST /v2/apps/deployments/{deployment-id}/runs adds upstream and downstream integrations, deployment metrics, human review workflows, and secret and configuration management, while POST /v2/apps/runs runs an app by app_name or app_id.

How do I process a batch of documents with the Instabase API through Jentic?

Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import Instabase from the API Directory, and store your token. Your agent searches for 'run an Instabase deployment on a batch', gets the deployment run operation with its input schema, and calls it with the batch_id, then polls the run and reads the results. To run it on your own infrastructure, install Jentic One from its GitHub repo.

Instabase API reference

AI ReadinessFoundational (C)55/100

See full scorecard

Official vendor OpenAPI document · agent-readyAI/MLMl Inferencebearer27 EndpointsREST

For Agents

Upload documents into Instabase batches, run automation apps or deployments over them, poll run status, and fetch extracted results with confidence scores and validation results.

Use for: I need to extract data from a folder of invoices with my Instabase app, Upload these PDFs to a new Instabase batch, Run my claims deployment on batch 4821, Check whether my Instabase run has finished

Not supported: Does not handle building or training Instabase apps, e-signatures, or document storage outside AI Hub. Use for uploading documents, running Instabase apps and deployments, and reading their results only.

The Instabase AI Hub API runs Instabase automation apps over your documents and returns the extracted results. You upload files into a batch, including large files through a multipart upload session, then run an app or a deployment against that batch and poll the run until it completes. Run results can include confidence scores, validation results, review results, and source information, and the API also reads and writes files in AI Hub storage, manages workspace secrets, and returns audit logs.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: ASignals: 4

97%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

50%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: C+Signals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

32%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: FSignals: 4

62%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

61%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: B-Signals: 1

60%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A-Signals: 1

73%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the API reference to your agent

Capabilities

Start building with API reference API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Instabase API reference

Jentic AI Readiness Score

API reference

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness