Hyland ECM REST API

Name: Hyland ECM REST API
Brand: Hyland ECM REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageDocument Managementbasic44 EndpointsREST

For Agents

Manage Hyland Saperion documents, folders, archives, users, and ACLs from an AI agent or backend automation that needs structured ECM access.

Install Jentic One Beta

Connect the Hyland ECM REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Hyland ECM REST 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 Hyland ECM REST API.

Retrieve a document by id, including specific revisions, from a Hyland archive

List archives, archive-scoped folders, and archive-scoped document collections

Create, update, and delete named or numeric access control lists

GET STARTED

Start building with Hyland ECM REST API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Hyland ECM REST API, keeping it validated and agent-ready. The Hyland Saperion Enterprise Content Management API exposes 44 endpoints for managing documents, folders, archives, users, access control lists, and workflow tasks across an on-premises ECM deployment. It supports archive-scoped document retrieval, document revisions, named ACLs, and named-vs-numeric folder lookups. Authentication is HTTP basic against the customer-hosted server defined in the base URL placeholder.

Use Cases

Patterns agents use Hyland ECM REST API for, with concrete tasks.

★ Automated Document Retrieval

Pull contract or invoice documents out of Hyland Saperion on demand from a downstream workflow such as a finance approval bot or a contract review service. The /documents/{documentId} and /archive/documents/{archiveId} endpoints support direct retrieval, and /documents/revisions/{revisionId} returns specific historical versions when audit trails matter.

GET /documents/{documentId} for the requested invoice id and stream the response into the approval workflow.

ACL and Compliance Management

Run periodic audits and remediation against Hyland ACLs by listing /management/acls, looking up specific ACLs by id or by name, and restoring deleted ACLs from /management/deleted/acls when records are lost. Supports compliance teams that need to prove who had access to which archive on which date.

GET /management/acls and reconcile each entry against the compliance baseline.

Archive Discovery and Field Mapping

When integrating Hyland with a new downstream system, programmatically discover archives via /archives and inspect their field schemas via /archive/{archiveId}/fields to build mapping configuration. The named-archive lookup /archives/{archive-name} supports symbolic names, which is useful when archive ids vary across environments.

GET /archives/Invoices then GET /archive/{archiveId}/fields to build the field mapping.

AI Agent ECM Assistant

Give an internal AI assistant the ability to fetch documents from Hyland on staff request without exposing the full ECM UI. Through Jentic the agent searches for 'retrieve a Hyland document', loads the input schema, and executes with the document id. Basic-auth credentials stay in the Jentic vault rather than the agent context, which is essential for content that may be regulated.

Search Jentic for 'retrieve a Hyland document by id', load the schema, and execute with the document id.

Key Endpoints

44 endpoints — jentic publishes the only available openapi specification for hyland ecm rest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/documents/{documentId}

Retrieve a document by id

GET

/documents/revisions/{revisionId}

Retrieve a specific document revision

GET

/archives

List archives on the server

GET

/archive/{archiveId}/fields

List fields for an archive

GET

/management/acls

List access control lists

GET

/management/deleted/acls

List deleted ACLs eligible for restore

GET

/archive/folders/{archiveId}

List folders in an archive

GET

/documents/{documentId}

Retrieve a document by id

GET

/documents/revisions/{revisionId}

Retrieve a specific document revision

GET

/archives

List archives on the server

GET

/archive/{archiveId}/fields

List fields for an archive

GET

/management/acls

List access control lists

Why Jentic?

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

Credential isolation

Hyland HTTP basic credentials are stored encrypted in the Jentic vault. Agents receive a scoped reference and Jentic injects the Authorization header at execution time, so the raw credentials never enter the agent's context or logs.

Intent-based discovery

Agents search Jentic by intent (e.g., 'retrieve a Hyland document') and Jentic returns the matching ECM operation with its input schema, removing the need to learn Saperion-specific URL conventions.

Time to first call

Direct Hyland integration: 3-5 days to wire up basic auth, archive discovery, and ACL handling for an on-premises deployment. Through Jentic: under half a day.

FAQs

Specific to using Hyland ECM REST API through Jentic.

Why is there no official OpenAPI spec for Hyland ECM REST API?

Hyland publishes Javadoc-based REST documentation rather than an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Hyland Saperion via structured tooling. It is validated against the documented API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Hyland ECM REST API use?

The Hyland API uses HTTP basic authentication against the customer-hosted Saperion server defined in the {server} placeholder of the base URL. Through Jentic the basic credentials sit in the credential vault and Jentic injects the Authorization header at execution time.

Can I retrieve a specific revision of a Hyland document?

Yes. GET /documents/revisions/{revisionId} returns a specific historical revision of a document. Use it alongside /documents/{documentId} when audit trails or version comparison are required for compliance workflows.

What are the rate limits for the Hyland ECM REST API?

Hyland Saperion is customer-hosted, so rate limits are determined by the customer's deployment capacity rather than a vendor-set quota. Coordinate batch reads with the Saperion administrator and watch for HTTP 429 or 503 responses to back off automatically.

How do I list archives on a Hyland server through Jentic?

Search Jentic for 'list Hyland archives', load the schema for GET /archives, and execute against the configured {server} host. Install with pip install jentic and use the async search, load, and execute pattern.

Can I restore a deleted ACL in Hyland?

Yes. List candidate deleted ACLs at /management/deleted/acls and call the corresponding restore operation under /management/deleted/acls/{aclId} to recover one. This is useful when a permission set is removed in error and needs to be reinstated.