Agility CMS REST API

Name: Agility CMS REST API
Brand: Agility CMS REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingContent ManagementapiKey15 EndpointsREST

For Agents

Read content items, pages, lists, sitemaps, and URL redirections from an Agility CMS instance via fetch (published) or preview (staging) endpoints, scoped by GUID and locale.

Install Jentic One Beta

Connect the Agility CMS REST API to your agent

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

Retrieve a single content item by ID with full field data and locale-specific values

List content items by reference name with pagination and filter options

Fetch flat or nested sitemaps for a channel to drive navigation builds

GET STARTED

Start building with Agility CMS REST API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Agility CMS REST API, keeping it validated and agent-ready. Agility CMS is a headless content management system that lets agents and applications fetch published content, preview staging content, and synchronise large catalogues of pages, lists, and galleries from a content instance. The API exposes 15 read endpoints scoped by instance GUID, API type (fetch or preview), and locale, covering single items, lists by reference name, sitemaps, paginated sync feeds, URL redirections, and content models. Authentication uses an APIKey header, and responses return structured JSON ready for downstream agent reasoning or static site rendering.

Use Cases

Patterns agents use Agility CMS REST API for, with concrete tasks.

★ Headless Site Rendering

Agents and frontends call Agility CMS to fetch the published content for a route, including the page record, its module data, and any list references. The API resolves locale, returns structured JSON for the page and its content items, and can be paired with the sitemap endpoints to build navigation. Integration is straightforward because every endpoint is a GET keyed by GUID, API type, and content path or ID.

Call GET /{guid}/fetch/en-us/page/{id} for page id 27 and return the title, modules, and zone names

Incremental Content Sync

For static site generators or external search indexes, agents poll the sync endpoints to pull only the content items and pages that changed since the last checkpoint token. The paged response is designed for full-corpus reload then incremental replay, so caches stay current without rebuilding from scratch each deploy.

Call GET /{guid}/fetch/en-us/sync/items with the previous sync token and write each returned item to a local cache

Preview Workflow for Editors

Editorial agents request the preview API type to see latest unpublished content alongside published content, useful for AI-assisted content review or pre-publish QA. The same path structure works against either the fetch or preview surface, so a single agent flow can switch between staging and production reads with one parameter change.

Call GET /{guid}/preview/en-us/list/blog-posts to fetch the latest staged blog posts for review

AI Agent Content Lookup via Jentic

An agent built on Jentic can answer natural-language questions about an Agility CMS instance — for example resolving a slug to a page record, retrieving the gallery used on a campaign, or summarising the latest items in a list. Jentic loads the request schema, injects the APIKey header from the vault, and executes the call without exposing the credential to the agent context.

Use Jentic to search 'fetch a page from agility cms', load the page-by-id schema, and return the page record

Key Endpoints

15 endpoints — jentic publishes the only available openapi specification for agility cms rest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/{guid}/{apitype}/{locale}/item/{id}

Get a content item by ID

GET

/{guid}/{apitype}/{locale}/list/{referenceName}

List content items by reference name

GET

/{guid}/{apitype}/{locale}/page/{id}

Get a page by ID

GET

/{guid}/{apitype}/{locale}/sitemap/nested/{channelName}

Get the nested sitemap for a channel

GET

/{guid}/{apitype}/{locale}/sync/items

Stream paginated content item changes

GET

/{guid}/{apitype}/{locale}/sync/pages

Stream paginated page changes

GET

/{guid}/{apitype}/urlredirection

List URL redirections updated since a date

GET

/{guid}/{apitype}/contentmodels

Return content model definitions

GET

/{guid}/{apitype}/{locale}/item/{id}

Get a content item by ID

GET

/{guid}/{apitype}/{locale}/list/{referenceName}

List content items by reference name

GET

/{guid}/{apitype}/{locale}/page/{id}

Get a page by ID

GET

/{guid}/{apitype}/{locale}/sitemap/nested/{channelName}

Get the nested sitemap for a channel

GET

/{guid}/{apitype}/{locale}/sync/items

Stream paginated content item changes

Why Jentic?

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

Credential isolation

The Agility CMS APIKey header is stored in the Jentic vault and injected at request time. Agents receive scoped execution rights, never the raw key, so a leaked agent transcript cannot expose the CMS credential.

Intent-based discovery

Agents search by intent (e.g. 'fetch a page from Agility CMS') and Jentic returns the matching operation with its input schema — guid, apitype, locale, id — so the agent calls the right endpoint without reading docs.

Time to first call

Direct integration: 1-2 days to wire up endpoints, locale handling, and sync pagination. Through Jentic: under an hour — search, load schema, execute.

FAQs

Specific to using Agility CMS REST API through Jentic.

Why is there no official OpenAPI spec for Agility CMS REST API?

Agility CMS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the Agility CMS REST API 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 Agility CMS REST API use?

The API uses an API key sent in the APIKey header on every request. Through Jentic, the key is held in the credential vault and injected at execution time, so the raw value never enters the agent context.

Can I read both published and draft content with the Agility CMS REST API?

Yes. Each path takes an apitype segment of either fetch (published content) or preview (latest, including staged content). The same item, list, and page endpoints work against both surfaces, so an agent can switch between production and staging reads by changing one path parameter.

What are the rate limits for the Agility CMS REST API?

The OpenAPI spec does not declare explicit rate limits. Treat the fetch surface as cached and read-heavy; for large catalogues use the /sync/items and /sync/pages endpoints with continuation tokens rather than polling individual items.

How do I fetch a specific page through Jentic?

Search Jentic for 'fetch an Agility CMS page', then load the GET /{guid}/{apitype}/{locale}/page/{id} operation schema and execute with the page id, locale, and your instance GUID. Jentic handles the APIKey header and returns the structured page record.

How do I keep a static site in sync with Agility CMS?

Use GET /{guid}/{apitype}/{locale}/sync/items and /sync/pages. Both return paged deltas; persist the continuation token between runs so subsequent calls only return changes. Pair with /urlredirection to refresh redirect rules between deploys.