VTEX · Agentic Access

VTEX Agentic Access

x-agentic-access generated

VTEX exposes 692 API operations that an AI agent could call, of which 382 are state-changing ‘acting’ operations. This is a recommended x-agentic-access execution contract — the scope, audience, consequence tier, short-lived token constraints, and escalation each action should carry before it is handed to an autonomous agent.

By consequence: 310 read, 266 write, 94 physical, and 22 safety-critical.

22 operations are classed safety-critical and should require human-in-the-loop approval at runtime.

Contracts are classified heuristically from the provider’s OpenAPI and refresh on every APIs.io network build; audience is bound per deployment. The model follows Curity’s Access Intelligence (apidays Munich 2026). Browse every provider’s agent contracts at agentic-access.apis.io.

CommerceE-CommerceRetailMarketplacePayments
Operations: 692 Acting: 382 Human-in-the-loop: 22 Method: generated

By consequence

read 310 write 266 physical 94 safety-critical 22

Highest-consequence actions

The physical and safety-critical operations an agent could invoke — the ones that most warrant scoped tokens, tight TTLs, and escalation. Full per-operation contracts are in the source below.

MethodPathConsequenceHuman-in-loop
POST /api/creditcontrol/accounts safety-critical required
DELETE /api/creditcontrol/accounts/{creditAccountId} safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId} safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/creditlimit safety-critical required
POST /api/creditcontrol/accounts/{creditAccountId}/holders safety-critical required
DELETE /api/creditcontrol/accounts/{creditAccountId}/holders/{holderId} safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId} safety-critical required
DELETE /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId} safety-critical required
POST /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/postponement safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/statements/{statementId} safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/tolerance safety-critical required
POST /api/creditcontrol/accounts/{creditAccountId}/transactions safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId} safety-critical required
DELETE /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId} safety-critical required
POST /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds safety-critical required
PUT /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/settlement safety-critical required
PUT /api/creditcontrol/storeconfig safety-critical required
POST /api/fulfillment/pvt/orders/{orderId}/fulfill safety-critical required
POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel safety-critical required
POST /api/vtexid/pub/providers/setup/password/webstore/password safety-critical required
DELETE /transactions/{transactions.Id} safety-critical required
POST /api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId} physical conditional
DELETE /api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId} physical conditional
POST /api/checkout/pub/gatewayCallback/{orderGroup} physical conditional

Source

Agentic Access

Raw ↑ 
generated: '2026-09-23'
method: generated
source: openapi/vtex-account-api-openapi.yml, openapi/vtex-addresses-api-openapi.yml, openapi/vtex-anti-fraud-flow-api-openapi.yml,
  openapi/vtex-app-keys-api-openapi.yml, openapi/vtex-attachment-api-openapi.yml, openapi/vtex-authentication-api-openapi.yml,
  openapi/vtex-autocomplete-api-openapi.yml, openapi/vtex-brand-api-openapi.yml, openapi/vtex-bulk-import-api-openapi.yml,
  openapi/vtex-carriers-api-openapi.yml, openapi/vtex-cart-attachments-api-openapi.yml, openapi/vtex-category-api-openapi.yml,
  openapi/vtex-category-specification-api-openapi.yml, openapi/vtex-change-order-beta-api-openapi.yml,
  openapi/vtex-change-seller-api-openapi.yml, openapi/vtex-change-uri-schema-api-openapi.yml,
  openapi/vtex-clusters-api-openapi.yml, openapi/vtex-collection-beta-api-openapi.yml, openapi/vtex-commercial-conditions-api-openapi.yml,
  openapi/vtex-configuration-api-openapi.yml, openapi/vtex-configuration-flow-api-openapi.yml,
  openapi/vtex-conversation-api-openapi.yml, openapi/vtex-coupons-api-openapi.yml, openapi/vtex-crossselling-api-openapi.yml,
  openapi/vtex-custom-data-api-openapi.yml, openapi/vtex-cycles-api-openapi.yml, openapi/vtex-data-subject-rights-api-openapi.yml,
  openapi/vtex-delivery-services-api-openapi.yml, openapi/vtex-dkim-configuration-api-openapi.yml,
  openapi/vtex-docks-api-openapi.yml, openapi/vtex-documents-api-openapi.yml, openapi/vtex-events-api-openapi.yml,
  openapi/vtex-external-marketplace-api-openapi.yml, openapi/vtex-external-seller-api-openapi.yml,
  openapi/vtex-facets-api-openapi.yml, openapi/vtex-feed-v2-deprecated-api-openapi.yml, openapi/vtex-feed-v3-api-openapi.yml,
  openapi/vtex-freight-values-api-openapi.yml, openapi/vtex-fulfillment-api-openapi.yml, openapi/vtex-get-suggestions-api-openapi.yml,
  openapi/vtex-get-versions-api-openapi.yml, openapi/vtex-gift-card-api-openapi.yml, openapi/vtex-gift-cards-api-openapi.yml,
  openapi/vtex-gift-list-api-openapi.yml, openapi/vtex-holidays-api-openapi.yml, openapi/vtex-indices-api-openapi.yml,
  openapi/vtex-installments-api-openapi.yml, openapi/vtex-inventory-api-openapi.yml, openapi/vtex-invoice-api-openapi.yml,
  openapi/vtex-invoices-api-openapi.yml, openapi/vtex-legacy-collection-api-openapi.yml, openapi/vtex-legacy-subcollection-api-openapi.yml,
  openapi/vtex-manage-suggestions-api-openapi.yml, openapi/vtex-match-received-skus-api-openapi.yml,
  openapi/vtex-matched-offers-api-openapi.yml, openapi/vtex-non-structured-specification-api-openapi.yml,
  openapi/vtex-note-api-openapi.yml, openapi/vtex-notification-api-openapi.yml, openapi/vtex-oauth-flow-api-openapi.yml,
  openapi/vtex-offer-management-api-openapi.yml, openapi/vtex-offers-api-openapi.yml, openapi/vtex-order-hook-api-openapi.yml,
  openapi/vtex-order-placement-api-openapi.yml, openapi/vtex-orders-api-openapi.yml, openapi/vtex-pages-api-openapi.yml,
  openapi/vtex-payment-api-openapi.yml, openapi/vtex-payment-flow-api-openapi.yml, openapi/vtex-pickup-points-api-openapi.yml,
  openapi/vtex-plans-api-openapi.yml, openapi/vtex-policy-api-openapi.yml, openapi/vtex-polygons-api-openapi.yml,
  openapi/vtex-price-tables-api-openapi.yml, openapi/vtex-prices-and-fixed-prices-api-openapi.yml,
  openapi/vtex-pricing-configuration-api-openapi.yml, openapi/vtex-pricing-hub-prices-api-openapi.yml,
  openapi/vtex-product-api-openapi.yml, openapi/vtex-product-indexing-api-openapi.yml, openapi/vtex-product-list-page-api-openapi.yml,
  openapi/vtex-product-specification-api-openapi.yml, openapi/vtex-profiles-api-openapi.yml,
  openapi/vtex-prospects-api-openapi.yml, openapi/vtex-provider-api-openapi.yml, openapi/vtex-purchase-information-api-openapi.yml,
  openapi/vtex-rating-api-openapi.yml, openapi/vtex-region-api-openapi.yml, openapi/vtex-reports-api-openapi.yml,
  openapi/vtex-reservations-api-openapi.yml, openapi/vtex-review-api-openapi.yml, openapi/vtex-roles-api-openapi.yml,
  openapi/vtex-sales-channel-api-openapi.yml, openapi/vtex-sales-channel-mapping-api-openapi.yml,
  openapi/vtex-scheduled-delivery-api-openapi.yml, openapi/vtex-schemas-api-openapi.yml, openapi/vtex-scroll-api-openapi.yml,
  openapi/vtex-search-api-openapi.yml, openapi/vtex-segment-api-openapi.yml, openapi/vtex-seller-api-openapi.yml,
  openapi/vtex-seller-commissions-api-openapi.yml, openapi/vtex-seller-invite-api-openapi.yml,
  openapi/vtex-sellers-api-openapi.yml, openapi/vtex-service-integration-api-openapi.yml, openapi/vtex-session-api-openapi.yml,
  openapi/vtex-settings-api-openapi.yml, openapi/vtex-shipping-policies-api-openapi.yml, openapi/vtex-shipping-updates-api-openapi.yml,
  openapi/vtex-shopping-cart-api-openapi.yml, openapi/vtex-similar-category-api-openapi.yml,
  openapi/vtex-sku-api-openapi.yml, openapi/vtex-sku-approval-settings-api-openapi.yml, openapi/vtex-sku-attachment-api-openapi.yml,
  openapi/vtex-sku-bindings-api-openapi.yml, openapi/vtex-sku-complement-api-openapi.yml, openapi/vtex-sku-ean-api-openapi.yml,
  openapi/vtex-sku-file-api-openapi.yml, openapi/vtex-sku-kit-api-openapi.yml, openapi/vtex-sku-seller-api-openapi.yml,
  openapi/vtex-sku-service-api-openapi.yml, openapi/vtex-sku-service-attachment-api-openapi.yml,
  openapi/vtex-sku-service-type-api-openapi.yml, openapi/vtex-sku-service-value-api-openapi.yml,
  openapi/vtex-sku-specification-api-openapi.yml, openapi/vtex-sla-api-openapi.yml, openapi/vtex-specification-api-openapi.yml,
  openapi/vtex-specification-field-api-openapi.yml, openapi/vtex-specification-field-value-api-openapi.yml,
  openapi/vtex-specification-group-api-openapi.yml, openapi/vtex-specification-value-api-openapi.yml,
  openapi/vtex-store-configuration-api-openapi.yml, openapi/vtex-stores-api-openapi.yml, openapi/vtex-subscriptions-api-openapi.yml,
  openapi/vtex-supplier-api-openapi.yml, openapi/vtex-task-api-openapi.yml, openapi/vtex-tracking-api-openapi.yml,
  openapi/vtex-trade-policy-api-openapi.yml, openapi/vtex-transaction-api-openapi.yml, openapi/vtex-transaction-flow-api-openapi.yml,
  openapi/vtex-transaction-process-api-openapi.yml, openapi/vtex-transactions-api-openapi.yml,
  openapi/vtex-user-orders-api-openapi.yml, openapi/vtex-users-api-openapi.yml, openapi/vtex-versions-api-openapi.yml,
  openapi/vtex-warehouses-api-openapi.yml
description: Recommended x-agentic-access execution contracts, classified heuristically from
  the OpenAPI. A governance starting point for exposing this API to AI agents — review and bind
  audience per deployment. See research/curity/agentic-governance/.
summary:
  operations: 692
  by_action_class:
    connected: 310
    acting: 382
  by_consequence:
    read: 310
    safety-critical: 22
    write: 266
    physical: 94
  human_in_the_loop_required: 22
operations:
- path: /api/creditcontrol/accounts
  method: get
  operationId: Searchallaccounts
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/creditcontrol/accounts
  method: post
  operationId: OpenanAccount
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}
  method: get
  operationId: RetrieveaAccountbyId
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/creditcontrol/accounts/{creditAccountId}
  method: delete
  operationId: CloseanAccount
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}
  method: put
  operationId: Updateemailanddescriptionofaaccount
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/statements
  method: get
  operationId: Accountstatements
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/creditcontrol/accounts/{creditAccountId}/creditlimit
  method: put
  operationId: ChangecreditlimitofanAccount
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/statements/{statementId}
  method: put
  operationId: Decreasebalanceofanaccount
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/settlement
  method: put
  operationId: CreateorUpdateSettlement
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/transactions
  method: post
  operationId: CreateaPreAuthorization
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}
  method: put
  operationId: CreateaPreAuthorization(usingid)
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}
  method: delete
  operationId: CancelaPreAuthorization
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/holders
  method: post
  operationId: AddanaccountHolder
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/holders/{holderId}
  method: delete
  operationId: Deleteanaccountholder
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/tolerance
  method: put
  operationId: Changetoleranceofanaccount
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds
  method: post
  operationId: PartialorTotalRefundaSettlement
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/vlm/account
  method: get
  operationId: GetAccount
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/storage/profile-system/profiles/{profileId}/addresses
  method: post
  operationId: CreateClientAddress
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/storage/profile-system/profiles/{profileId}/addresses
  method: get
  operationId: GetClientAddresses
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/storage/profile-system/profiles/{profileId}/addresses/unmask
  method: get
  operationId: GetUnmaskedClientAddresses
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
  method: get
  operationId: GetAddress
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
  method: patch
  operationId: UpdateClientAddress
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}
  method: delete
  operationId: DeleteAddress
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask
  method: get
  operationId: GetUnmaskedAddress
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}
  method: get
  operationId: GetAddressByVersion
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask
  method: get
  operationId: GetUnmaskedAddressByVersion
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /pre-analysis
  method: post
  operationId: SendAntifraudPreAnalysisData
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /transactions
  method: post
  operationId: SendAntifraudData
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /transactions/{transactionId}
  method: put
  operationId: UpdateAntifraudTransactions(optional)
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /manifest
  method: get
  operationId: Manifest
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /transactions/{transactions.id}
  method: get
  operationId: GetAntifraudStatus
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /transactions/{transactions.Id}
  method: delete
  operationId: StopAntifraudAnalysis(optional)
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/vlm/appkeys
  method: post
  operationId: Createnewappkey
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/vlm/appkeys
  method: get
  operationId: Getappkeysfromaccount
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/vlm/appkeys/{id}
  method: put
  operationId: Updateappkey
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog/pvt/attachment/{attachmentid}
  method: get
  operationId: getApiCatalogPvtAttachmentByAttachmentid
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog/pvt/attachment/{attachmentid}
  method: put
  operationId: putApiCatalogPvtAttachmentByAttachmentid
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog/pvt/attachment/{attachmentid}
  method: delete
  operationId: deleteApiCatalogPvtAttachmentByAttachmentid
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog/pvt/attachment
  method: post
  operationId: postApiCatalogPvtAttachment
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog/pvt/attachments
  method: get
  operationId: getApiCatalogPvtAttachments
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/vtexid/apptoken/login
  method: post
  operationId: postApiVtexidApptokenLogin
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/vtexid/audience/webstore/provider/oauth/exchange
  method: post
  operationId: postApiVtexidAudienceWebstoreProviderOauthExchange
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/vtexid/credential/validate
  method: post
  operationId: postApiVtexidCredentialValidate
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/vtexid/pub/providers/setup/password/webstore/password
  method: post
  operationId: postApiVtexidPubProvidersSetupPasswordWebstorePassword
  x-agentic-access:
    action-class: acting
    consequence: safety-critical
    subject: required
    audience: null
    token:
      max-ttl: 120
      exchange: true
      purpose-required: true
      proof-of-possession: true
    escalation:
      human-in-the-loop: required
    audit: required
- path: /api/vtexid/password/expire
  method: post
  operationId: postApiVtexidPasswordExpire
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /token
  method: post
  operationId: Createtoken
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /auth
  method: post
  operationId: postAuth
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /top_searches
  method: get
  operationId: getTopSearches
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /autocomplete_suggestions
  method: get
  operationId: getAutocompleteSuggestions
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /search_suggestions
  method: get
  operationId: getSearchSuggestions
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /buscaautocomplete
  method: get
  operationId: AutoComplete
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog-seller-portal/brands
  method: get
  operationId: ListBrand
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog-seller-portal/brands
  method: post
  operationId: PostBrand
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog-seller-portal/brands/{brandId}
  method: get
  operationId: GetBrand
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog-seller-portal/brands/{brandId}
  method: put
  operationId: PutBrand
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog_system/pvt/brand/list
  method: get
  operationId: BrandList
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog_system/pvt/brand/pagedlist
  method: get
  operationId: BrandListPerPage
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog_system/pvt/brand/{brandId}
  method: get
  operationId: Brand
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog/pvt/brand
  method: post
  operationId: postApiCatalogPvtBrand
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog/pvt/brand/{brandId}
  method: get
  operationId: getApiCatalogPvtBrandByBrandId
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog/pvt/brand/{brandId}
  method: put
  operationId: putApiCatalogPvtBrandByBrandId
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog/pvt/brand/{brandId}
  method: delete
  operationId: deleteApiCatalogPvtBrandByBrandId
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/b2b/import/buyer-orgs
  method: post
  operationId: UploadFile
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/b2b/import/buyer-orgs/{importId}
  method: get
  operationId: CheckProgress
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/b2b/import/buyer-orgs/{importId}
  method: post
  operationId: postApiB2bImportBuyerOrgsByImportId
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/b2b/import/buyer-orgs/validate/{importId}
  method: post
  operationId: ValidateFile
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /rates
  method: post
  operationId: Createservice
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /list-carriers
  method: post
  operationId: Createservice
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/checkout/pub/profiles
  method: get
  operationId: GetClientProfileByEmail
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData
  method: post
  operationId: AddClientProfile
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData
  method: post
  operationId: AddShippingAddress
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData
  method: post
  operationId: AddClientPreferences
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData
  method: post
  operationId: AddMarketingData
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData
  method: post
  operationId: AddPaymentData
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData
  method: post
  operationId: AddMerchantContextData
  x-agentic-access:
    action-class: acting
    consequence: physical
    subject: required
    audience: null
    token:
      max-ttl: 300
      exchange: true
      purpose-required: true
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required
- path: /api/catalog-seller-portal/category-tree
  method: get
  operationId: GetCategoryTree
  x-agentic-access:
    action-class: connected
    consequence: read
    subject: optional
    token:
      max-ttl: 3600
    audit: none
- path: /api/catalog-seller-portal/category-tree
  method: put
  operationId: UpdateCategoryTree
  x-agentic-access:
    action-class: acting
    consequence: write
    subject: required
    audience: null
    token:
      max-ttl: 900
    escalation:
      human-in-the-loop: conditional
      triggers:
      - abnormal
      - high-value
    audit: required


# --- truncated at 32 KB (228 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/agentic-access/vtex-agentic-access.yml

Work with this as data

Every access contract here is available over the APIs.io API and to AI agents over MCP. Agentic Access is not yet its own endpoint on the v1 API. Reach it through catalog search and the tag graph, or the MCP server.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for agentic access

3 MCP tools reach this
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
Search the catalog 
curl "https://apis.io/api/v1/search?q=vtex-agentic-access&limit=10"
Everything under a tag 
curl "https://apis.io/api/v1/tags/vtex-agentic-access"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.