Master Data API - v2

Name: Master Data API - v2 API
Brand: Master Data API - v2
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsSource ControlapiKey20 EndpointsREST

For Agents

Programmatically create new document, create partial document. Covers 20 operations with apiKey authentication.

Connect the Master Data API - v2 to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Master Data API - v2, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

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

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 Master Data API - v2 API.

Create new document

Get document

Update partial document

Delete document

Search documents

GET STARTED

Start building with Master Data API - v2 API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Master Data API - v2, keeping it validated and agent-ready.

>ℹ️ Master Data v2 is not compatible with data entities from previous versions, such as CL and AD. [Master Data](https://developers.vtex.com/docs/guides/master-data-introduction) is a secure, fast, scalable, and extensible solution that allows users to create their own entities, store data, and retrieve information directly from the storefront or external integrations. Several internal VTEX module. The API exposes 20 endpoints secured with apiKey authentication.

Use Cases

Patterns agents use Master Data API - v2 API for, with concrete tasks.

★ Developer Tools Operations

Use the Master Data API - v2 to perform developer tools operations programmatically. The API provides 20 endpoints covering core functionality including create new document, create partial document, get document.

Call POST /api/dataentities/{dataEntityName}/documents to create new document

Automated Documents Management

Automate documents operations by combining multiple Master Data API - v2 endpoints. Agents can create partial document and then get document in a single workflow.

Call PATCH /api/dataentities/{dataEntityName}/documents to create partial document, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Master Data API - v2 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 apiKey tokens manually.

Search Jentic for 'create new document', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

20 endpoints — >ℹ️ master data v2 is not compatible with data entities from previous versions, such as cl and ad.

METHOD

PATH

DESCRIPTION

POST

/api/dataentities/{dataEntityName}/documents

Create new document

PATCH

/api/dataentities/{dataEntityName}/documents

Create partial document

GET

/api/dataentities/{dataEntityName}/documents/{id}

Get document

PUT

/api/dataentities/{dataEntityName}/documents/{id}

Create document with custom ID or update entire document

PATCH

/api/dataentities/{dataEntityName}/documents/{id}

Update partial document

DELETE

/api/dataentities/{dataEntityName}/documents/{id}

Delete document

GET

/api/dataentities/{dataEntityName}/search

Search documents

GET

/api/dataentities/{dataEntityName}/scroll

Scroll documents

POST

/api/dataentities/{dataEntityName}/documents

Create new document

PATCH

/api/dataentities/{dataEntityName}/documents

Create partial document

GET

/api/dataentities/{dataEntityName}/documents/{id}

Get document

PUT

/api/dataentities/{dataEntityName}/documents/{id}

Create document with custom ID or update entire document

PATCH

/api/dataentities/{dataEntityName}/documents/{id}

Update partial document

Why though Jentic?

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

Credential isolation

Master Data API - v2 apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'create new document') and Jentic returns the matching Master Data API - v2 operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Master Data API - v2 integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Github

Alternative developer tools API

Choose Github when you need a different approach to developer tools operations

Alternative

Gitlab

Alternative developer tools API

Choose Gitlab when you need a different approach to developer tools operations

FAQs

Specific to using Master Data API - v2 API through Jentic.

What authentication does the Master Data API - v2 use?

The Master Data API - v2 uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in the MAXsystem vault and injected at execution time, so raw secrets never enter the agent context.

Can I create new document with the Master Data API - v2?

Yes. Use the POST /api/dataentities/{dataEntityName}/documents endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Master Data API - v2?

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 create new document through Jentic?

Install the Jentic SDK with pip install jentic, authenticate at https://app.jentic.com/sign-up, then search for 'create new document'. Jentic returns the matching Master Data API - v2 operation with its input schema. Load the schema and execute the call — credentials are injected automatically.

How many endpoints does the Master Data API - v2 have?

The Master Data API - v2 exposes 20 endpoints covering documents, search, scroll operations.