VTEX Headless CMS

Name: VTEX Headless CMS API
Brand: VTEX Headless CMS
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingContent Managementnone3 EndpointsREST

For Agents

Programmatically get all content types, get all cms pages by content type. Covers 3 operations.

Use for: I need to all content types, I want to all cms pages by content type, Search for cms page, List all records from VTEX Headless CMS

Not supported: Does not handle payments, communications, or crm - use for marketing only.

The [VTEX Headless CMS](https://www.faststore.dev/docs/headless-cms-overview) is a solution for storefront content management. You can use the Headless CMS API to fetch data about your project's pages and content types, including `status`, `id`, and `type`. Index Pages - `GET` [Get all Content Types](https://developers.vtex.com/docs/api-reference/headless-cms-api#get-/_v/cms/api/-projectId-) - `GE. The API exposes 3 endpoints.

Install Jentic One Beta

Connect the VTEX Headless CMS to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the VTEX Headless CMS, 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%2Fvtex.local%2Fvtex-headless-cms" | 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%2Fvtex.local%2Fvtex-headless-cms" | 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 VTEX Headless CMS API.

Get all content types

Manage marketing data programmatically

Integrate VTEX Headless CMS into automated workflows

Query and filter VTEX Headless CMS records by parameters

Monitor VTEX Headless CMS operational status and events

GET STARTED

Start building with VTEX Headless CMS API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use VTEX Headless CMS API for, with concrete tasks.

★ Marketing Operations

Use the VTEX Headless CMS to perform marketing operations programmatically. The API provides 3 endpoints covering core functionality including get all content types, get all cms pages by content type, get cms page.

Call GET /_v/cms/api/{projectId} to get all content types

Automated Pages Management

Automate pages operations by combining multiple VTEX Headless CMS endpoints. Agents can get all cms pages by content type and then get cms page in a single workflow.

Call GET /_v/cms/api/{projectId}/{content-type} to get all cms pages by content type, then verify the result

AI Agent Integration via Jentic

AI agents discover and call VTEX Headless CMS endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Search Jentic for 'get all content types', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

3 endpoints — the [vtex headless cms](https://www.

METHOD

PATH

DESCRIPTION

GET

/_v/cms/api/{projectId}

Get all content types

GET

/_v/cms/api/{projectId}/{content-type}

Get all CMS pages by content type

GET

/_v/cms/api/{projectId}/{content-type}/{document-id}

Get CMS page

GET

/_v/cms/api/{projectId}

Get all content types

GET

/_v/cms/api/{projectId}/{content-type}

Get all CMS pages by content type

GET

/_v/cms/api/{projectId}/{content-type}/{document-id}

Get CMS page

Why Jentic?

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

Setup

Wiring the VTEX Headless CMS by hand means resolving the {accountName}.myvtex.com host and threading the CMS project id through each content route yourself. Through Jentic you install once, import the VTEX Headless CMS from the API Directory, and your agent calls it.

Permission scoping

The VTEX Headless CMS puts the project id in the URL path (/_v/cms/api/{projectId}/{content-type}), so a rule can pin your agent to one CMS project. Every operation here reads content, so you can limit the agent to fetching content types and documents and nothing more.

Credential isolation

This VTEX Headless CMS endpoint set is public and needs no credential, so there is no secret for your agent to hold. Any configuration your Jentic One instance stores is kept encrypted and injected at execution time, never entering the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'list content types for a CMS project' or 'get a CMS document', and Jentic returns the matching VTEX Headless CMS operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using VTEX Headless CMS API through Jentic.

What authentication does the VTEX Headless CMS use?

The VTEX Headless CMS uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

Can I get all content types with the VTEX Headless CMS?

Yes. Use the GET /_v/cms/api/{projectId} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the VTEX Headless CMS?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

How do I get all content types through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get all content types'. Jentic returns the matching VTEX Headless CMS operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

How many endpoints does the VTEX Headless CMS have?

The VTEX Headless CMS exposes 3 endpoints covering pages operations.

Can I limit what my agent is allowed to do with the VTEX Headless CMS API?

Yes. Because you run Jentic One yourself, your own rules decide which VTEX Headless CMS operations your agent may call. Every endpoint here is read-only, so you can allow only GET /_v/cms/api/{projectId} to list content types, GET /_v/cms/api/{projectId}/{content-type} to fetch pages, and GET /_v/cms/api/{projectId}/{content-type}/{document-id} to read a single document, with no ability to write. Since the project id sits in the URL path, you can also pin the agent to a single CMS project and block access to any other.

VTEX Headless CMS

Connect the VTEX Headless CMS to your agent

Capabilities

Start building with VTEX Headless CMS API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs