# AIMEAT Commerce API

**Canonical:** https://apis.io/apis/aimeat-io/aimeat-io-commerce-api/  
**Provider:** AIMEAT — https://apis.io/providers/aimeat-io/  
**Base URL:** https://aimeat-finland-001-genesis.overscalesolutions.com  
**Documentation:** https://aimeat.io/v1/spec

AIMEAT Commerce API is one of 100 APIs that [AIMEAT](https://apis.io/providers/aimeat-io/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Commerce. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Protocol-agnostic checkout sessions over agent offers (TARGET-033) + UCP discovery

## Operations (60 of 89)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/exchange/entitlements` | Accept an EXCHANGE contract → mint a metered entitlement (EXCHANGE / TARGET-045) |
| GET | `/v1/exchange/entitlements` | List the caller-owner's EXCHANGE entitlements (EXCHANGE / TARGET-045) |
| POST | `/v1/exchange/entitlements/off` | Pause or revoke one of your EXCHANGE entitlements (EXCHANGE / TARGET-045) |
| POST | `/v1/exchange/entitlements/merge` | Fold per-caller rights into the one right their owner holds (operator) |
| POST | `/v1/exchange/grants` | Carry a consumer's access instead of billing them — issue an EXCHANGE grant |
| GET | `/v1/exchange/grants` | Everyone you are carrying, and what it has cost you |
| POST | `/v1/exchange/grants/revoke` | Withdraw a grant — one, or every grant an app approval issued |
| POST | `/v1/exchange/proposals` | Propose new terms for a live contract — renegotiation (EXCHANGE / TARGET-045) |
| GET | `/v1/exchange/proposals` | List contract-change proposals you are party to (EXCHANGE / TARGET-045) |
| POST | `/v1/exchange/proposals/{id}/accept` | Accept a proposed contract change — supersede (EXCHANGE / TARGET-045) |
| POST | `/v1/exchange/proposals/{id}/decline` | Decline a proposed contract change (EXCHANGE / TARGET-045) |
| POST | `/v1/exchange/proposals/{id}/withdraw` | Withdraw your own pending contract-change proposal (EXCHANGE / TARGET-045) |
| GET | `/v1/exchange/entitlements/history` | Your PAST (archived / superseded) contracts as consumer (EXCHANGE / TARGET-045) |
| GET | `/v1/exchange/provider/history` | Your PAST (archived / superseded) contracts as provider (EXCHANGE / TARGET-045) |
| GET | `/v1/exchange/earnings` | What you have EARNED and not yet been paid — the seller's accrued payables… |
| POST | `/v1/commerce/beneficiary-splits` | Declare who shares what this capability earns — the second rake (beneficiary… |
| GET | `/v1/commerce/beneficiary-splits` | Every beneficiary split you have declared |
| DELETE | `/v1/commerce/beneficiary-splits` | Withdraw a beneficiary split |
| GET | `/v1/commerce/beneficiary/earnings` | What you have been given a share of — accrued beneficiary income |
| GET | `/v1/commerce/beneficiary/obligations` | What you OWE your beneficiaries |
| POST | `/v1/commerce/beneficiary/release` | Pay one accrued beneficiary share |
| GET | `/v1/commerce/beneficiary/payout` | What you still owe a beneficiary, and the x402 requirements to pay it |
| POST | `/v1/commerce/beneficiary/payout` | Settle what you owe a beneficiary with your signed authorisation |
| GET | `/v1/commerce/beneficiary/possible-payouts` | The beneficiary payouts whose settlement did not answer (OPERATOR ONLY) |
| POST | `/v1/commerce/beneficiary/possible-payouts/arrived` | Mark a possible payout as arrived, with a reference (OPERATOR ONLY) |
| POST | `/v1/commerce/beneficiary/approvals` | Record whether a beneficiary may be paid at all (OPERATOR ONLY) |
| GET | `/v1/commerce/beneficiary/approvals` | Whether an account may be paid a beneficiary share |
| POST | `/v1/exchange/work` | Start an AGENT-WORK task under a contract — async, settled on delivery… |
| GET | `/v1/exchange/work` | List your AGENT-WORK items (EXCHANGE / TARGET-045 Gap 2) |
| POST | `/v1/exchange/work/{id}/deliver` | Deliver an agent-work task → settle on delivery (EXCHANGE / TARGET-045 Gap 2) |
| GET | `/v1/exchange/info` | EXCHANGE marketplace economics — the platform rake + units (EXCHANGE /… |
| POST | `/v1/exchange/offerings` | List a supply OFFERING — an ext action or an app-tool you own (EXCHANGE… |
| GET | `/v1/exchange/offerings` | Browse listed EXCHANGE offerings (public) — by capability or free text… |
| GET | `/v1/exchange/offerings/{id}` | One EXCHANGE offering's full detail — I/O schema, call recipe, usage stats… |
| DELETE | `/v1/exchange/offerings/{id}` | Delist one of your EXCHANGE offerings (TARGET-045) |
| GET | `/v1/exchange/offerings/{id}/odps` | One EXCHANGE offering as an Open Data Product Specification v4.1 document… |
| GET | `/v1/exchange/offerings/{id}/odps.yaml` | One EXCHANGE offering as an ODPS v4.1 YAML document (public) (TARGET-045) |
| POST | `/v1/exchange/reconcile` | Reconcile your EXCHANGE listings against their sources (TARGET-050) |
| GET | `/v1/exchange/offerings/{id}/consumers` | Provider data-lineage — who holds contracts against your offering (owner only)… |
| POST | `/v1/exchange/needs` | Post an open NEED (demand) providers can bid on (EXCHANGE marketplace /… |
| GET | `/v1/exchange/needs` | Browse EXCHANGE needs — `?open=1` open only, `?mine=1` your own (TARGET-045) |
| POST | `/v1/exchange/needs/{id}/close` | Close one of your EXCHANGE needs (TARGET-045) |
| POST | `/v1/exchange/needs/{id}/bids` | Bid on an open NEED with an action your extension owns (EXCHANGE / TARGET-045) |
| GET | `/v1/exchange/needs/{id}/bids` | List bids on a NEED (public) (TARGET-045) |
| POST | `/v1/exchange/needs/{id}/bids/{bidId}/accept` | Accept a bid on your NEED → mint the metered entitlement (EXCHANGE / TARGET-045) |
| GET | `/.well-known/ucp` | UCP business profile (Universal Commerce Protocol 2026-08-25) |
| GET | `/.well-known/ucp/2026-04-08` | UCP business profile, version 2026-04-08 (the signed-in checkout) |
| POST | `/v1/attestations` | Create a co-signed attestation (the trade-deed primitive) |
| GET | `/v1/attestations/{id}` | Read an attestation publicly — the node re-verifies every signature |
| POST | `/v1/attestations/{id}/sign` | Sign as the identity you are (completes when all parties have signed) |
| GET | `/v1/commerce/orders` | List received orders (seller view) |
| POST | `/v1/commerce/holds` | Authorize a hold on the buyer's instrument toward one seller (no money moves) |
| GET | `/v1/commerce/holds` | List the caller's holds (buyer side by default, seller side with side=seller) |
| GET | `/v1/commerce/holds/{id}` | Read one hold (buyer or seller; lazy expiry applies) |
| POST | `/v1/commerce/holds/{id}/capture` | Capture a hold (seller only, up to the held amount; partial = second price) |
| POST | `/v1/commerce/holds/{id}/release` | Release an open hold (buyer or seller) |
| GET | `/v1/commerce/payout` | Which payout rails can pay you, and what each needs (owner, or their agent with… |
| PUT | `/v1/commerce/payout/x402` | Set your stablecoin (x402) payout address (owner) (TARGET-042) |
| DELETE | `/v1/commerce/payout/x402` | Remove your stablecoin (x402) payout address (owner) (TARGET-042) |
| PUT | `/v1/commerce/payout/invoice` | Take invoice payment for items delivered at once, or not (owner, or their agent… |

…and 29 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/aimeat-io/openapi/aimeat-io-commerce-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-workflow-def-input-schema.json
- **JSONSchema** — https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-workflow-run-schema.json
- **JSONSchema** — https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-schedule-create-schema.json
- **JSONSchema** — https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-ai-provenance-declaration-schema.json
- **JSONSchema** — https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-app-summary-schema.json
- **JSONSchema** — https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-memory-write-schema.json

## Other AIMEAT APIs (12)

- [AIMEAT A2A API](https://apis.io/apis/aimeat-io/aimeat-io-a2a-api/)
- [AIMEAT Actions API](https://apis.io/apis/aimeat-io/aimeat-io-actions-api/)
- [AIMEAT Admin API](https://apis.io/apis/aimeat-io/aimeat-io-admin-api/)
- [AIMEAT Agent Crew API](https://apis.io/apis/aimeat-io/aimeat-io-agent-crew-api/)
- [AIMEAT Agent Directives API](https://apis.io/apis/aimeat-io/aimeat-io-agent-directives-api/)
- [AIMEAT Agent Goals API](https://apis.io/apis/aimeat-io/aimeat-io-agent-goals-api/)
- [AIMEAT Agent Integration API](https://apis.io/apis/aimeat-io/aimeat-io-agent-integration-api/)
- [AIMEAT Agent Messages API](https://apis.io/apis/aimeat-io/aimeat-io-agent-messages-api/)
- [AIMEAT Agent Onboarding API](https://apis.io/apis/aimeat-io/aimeat-io-agent-onboarding-api/)
- [AIMEAT Agent Tasks API](https://apis.io/apis/aimeat-io/aimeat-io-agent-tasks-api/)
- [AIMEAT Agent Telemetry API](https://apis.io/apis/aimeat-io/aimeat-io-agent-telemetry-api/)
- [AIMEAT Agent Webhooks API](https://apis.io/apis/aimeat-io/aimeat-io-agent-webhooks-api/)

## Tags

Commerce

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/aimeat-io/aimeat-io-commerce-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/aimeat-io/.
