EziDox API
★ Only Publicly Available OpenAPI DocumentStorageDocument ManagementapiKey1 EndpointsREST
For Agents
Verify EziDox connectivity and X-API-Key credentials against the v2.0 Applications test endpoint at api.ezidox.com.
Use for: I need to confirm my EziDox API key works, Run a smoke test against the EziDox v2.0 API, Check whether api.ezidox.com is reachable from my environment, Verify EziDox credentials before deploying an integration
Not supported: Does not handle document upload, e-signature, or workflow management - use for v2.0 credential and connectivity verification only.
Jentic publishes the only available OpenAPI specification for EziDox API, keeping it validated and agent-ready. EziDox is a document-management and e-signature platform, and version 2.0 of its public API is intentionally narrow: a single Applications/Test endpoint that lets integrators verify connectivity and credentials before progressing to the broader product workflows. Authentication is by an X-API-Key header.
Install Jentic One Beta
Connect the EziDox API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the EziDox 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.
1
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 | sh2
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 instanceJentic 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 EziDox API.
Verify the configured X-API-Key against the v2.0 EziDox API via /api/v2.0/Applications/Test
Confirm baseline connectivity to api.ezidox.com before deeper integration
Smoke-test EziDox credentials in CI pipelines before deployment
Detect credential rotation issues by treating non-2xx responses as a failure signal
Use Cases
Patterns agents use EziDox API for, with concrete tasks.
★ Credential Smoke Test
Use the single /api/v2.0/Applications/Test endpoint to confirm that the configured EziDox X-API-Key is valid and that api.ezidox.com is reachable. Suitable for CI pipelines that gate deployment of an EziDox integration on a green credential check, and for periodic monitors that detect rotated or revoked keys.
Call /api/v2.0/Applications/Test with the X-API-Key header and assert a 2xx status code in the deployment pipeline.
Pre-Integration Connectivity Check
Before wiring deeper EziDox workflows in a downstream service, run /api/v2.0/Applications/Test to validate that the network path, TLS configuration, and X-API-Key are all in good shape. Use it in onboarding scripts that first-time customers run after pasting their key into a configuration UI.
Call /api/v2.0/Applications/Test from the onboarding script and surface a clear error message to the user when the response is non-2xx.
Agent-Driven Credential Health Check via Jentic
An AI agent that orchestrates document workflows can use Jentic to run the EziDox connectivity test without embedding the bespoke client. The X-API-Key value lives in your Jentic One instance, so the agent can fire the smoke test on demand without ever holding the raw key in its prompt context.
Through Jentic, search 'verify EziDox credentials', load /api/v2.0/Applications/Test, and execute it as part of the agent's daily health-check routine.
Key Endpoints
1 endpoints — jentic publishes the only available openapi specification for ezidox api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/api/v2.0/Applications/Test
Verify connectivity and the X-API-Key
GET
/api/v2.0/Applications/Test
Verify connectivity and the X-API-Key
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Your EziDox X-API-Key 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 'verify EziDox credentials', and Jentic returns the /api/v2.0/Applications/Test operation with its input schema so the agent calls the right endpoint without needing the exact path or header name.
Time to first call
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using EziDox API through Jentic.
Why is there no official OpenAPI spec for EziDox API?
EziDox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call EziDox API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the EziDox API use?
The spec declares an apiKey scheme that expects the X-API-Key header on the /api/v2.0/Applications/Test request. Store the key in your Jentic One instance so it is supplied to the request at execution time without leaking into the agent prompt.
Can I attach an e-signature to a document with this OpenAPI spec?
Not directly. The currently published OpenAPI spec covers only the /api/v2.0/Applications/Test connectivity endpoint; the broader EziDox e-signature operations are not yet exposed in this spec, so use it as a credential health check only.
How do I verify my EziDox credentials through Jentic?
Run pip install jentic, search 'verify EziDox credentials', load /api/v2.0/Applications/Test, and execute it; Jentic injects the X-API-Key header from the vault and returns the result for your CI to assert on.
What are the rate limits for the EziDox API?
The spec does not declare explicit rate limits, so use the test endpoint sparingly - for example as part of CI runs and scheduled health checks rather than as a tight polling loop.
Is the EziDox API free?
EziDox is a paid commercial document-management product, so use of the API is governed by your EziDox subscription rather than by the OpenAPI spec; consult the EziDox sales documentation for the current commercial terms.
GET STARTED