Vtex Session Manager API

Name: Session Manager API
Brand: Session Manager API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentIdentity AuthAuthenticationapiKey4 EndpointsREST

For Agents

Programmatically create new session, get session. Covers 4 operations with apiKey authentication.

Use for: I need to new session, I want to session, Search for edit session, Find all segment

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

Session Manager tracks the current browsing sessions of all customers on the VTEX platform. Important session information is automatically captured and stored in a secure and easily accessible location. This includes data such as relevant cookies, query strings, authentication credentials, current profile and pricing information, if applicable. Session Manager API allows developers to retrieve and. The API exposes 4 endpoints secured with apiKey authentication.

Install Jentic One Beta

Connect the Session Manager API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Session Manager 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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvtex.local%2Fsession-manager-api" | 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%2Fsession-manager-api" | 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 Session Manager API.

Create new session

Get session

Edit session

Query and filter Session Manager API records by parameters

Monitor Session Manager API operational status and events

GET STARTED

Start building with Session Manager API

Explore with Jentic One

View OpenAPI Document

Automated Session Management

Automate session operations by combining multiple Session Manager API endpoints. Agents can get session and then edit session in a single workflow.

Call GET /api/sessions to get session, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Session Manager API 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 session', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

4 endpoints — session manager tracks the current browsing sessions of all customers on the vtex platform.

METHOD

PATH

DESCRIPTION

POST

/api/sessions

Create new session

GET

/api/sessions

Get session

PATCH

/api/sessions

Edit session

GET

/api/segments

Get segment

POST

/api/sessions

Create new session

GET

/api/sessions

Get session

PATCH

/api/sessions

Edit session

GET

/api/segments

Get segment

Why Jentic?

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

Setup

Wiring the VTEX Session Manager API by hand means carrying the vtex_session and vtex_segment cookies on each request and templating the {accountName} and {environment} host into every call. Through Jentic you install once, import the Session Manager API from the API Directory, store the session credential once, and your agent calls it.

Permission scoping

The Session Manager API acts on the current session through the request body and cookies rather than a resource id in the path, so limit the agent to the operations it needs, such as reading session data. You choose whether to include writes like creating or patching a session.

Credential isolation

Your VTEX session credential 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 'create a new session' or 'read the current session segments', and Jentic returns the matching Session Manager API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Session Manager API through Jentic.

What authentication does the Session Manager API use?

The Session Manager API uses an API key passed in the `vtex_session` cookie. 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 create new session with the Session Manager API?

Yes. Use the POST /api/sessions endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Session Manager API?

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 session through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create new session'. Jentic returns the matching Session Manager API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

How many endpoints does the Session Manager API have?

The Session Manager API exposes 4 endpoints covering session, segment operations.

Can I limit what my agent is allowed to do with the Session Manager API?

Yes. Because you run Jentic One yourself, your own rules decide which Session Manager API operations and credentials the agent may use. You can allow only the read calls, such as GET /api/sessions to read the current session and GET /api/segments to read its segments, while withholding the writes like POST /api/sessions to create a session or PATCH /api/sessions to edit one. Since the API acts on the current session through the request body and cookies rather than a resource id in the path, scoping is controlled by which operations you enable and the credential you store.

Vtex Session Manager API

Connect the Session Manager API to your agent

Capabilities

Start building with Session Manager API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs