HTTP API

API Reference

Query offers from user intent with Offer Query, read known Offer details with OfferInfo, or look up Offer cards you were served with the Offer Instance API; both use a Live API Key. Use Location Search for registry lookup and normalization. Get the placement id that identifies your integration in Developer Portal.

Base URL: https://api.aon.pro
Identity: Placement ID · Live Key for OfferInfo and Offer Instance
Contract: OpenAPI connected

API surfaces

Choose an operation and work directly from its schema and examples. A resolved location id can be sent as the optional Query v1.0 viewer location.

4 public surfaces

Query

Offer Query

Send intent, context, constraints, and pagination fields to discover offers for AI product or agent experiences.

POST/v1/offers/queryPlacement ID

Details

OfferInfo API

Read current stored details and the lifecycle status of up to 1000 Offers per call by canonical Offer ID using a Live API Key, with the same business information as Query and no new distribution instance.

POST/v1/offers/infoBearer required

Details

Offer Instance API

Look up as many as 100 Offer cards your application has already served, by offer_instance_id, using a Live API Key from your server. Get when each card was served, its placement, the Offer's current details and status, and the original tracked link while it can still be opened.

POST/v1/offers/instancesBearer required

Lookup

Location Search

Search and normalize AON Location Registry ids for location pickers, Offer-side geographic targeting, and the optional Query v1.0 viewer location.

GET/v1/locations/searchPublic

GET/v1/locations/resolvePublic

GET/v1/locations/{location_id}Public

First request

Start with a bounded query

Run the Public Test Sandbox to inspect a fixed v1.0 Query and response.
For production traffic, send your placement id in the X-AON-Placement-Id header to earn attribution; without one the query is served in anonymous mode.
Send structured intent and only v1.0-declared context, then preserve returned actions and tracking data.

Run the Public Test Sandbox →Read the production first-call guide →

First offer query

curl

curl -X POST https://api.aon.pro/v1/offers/query \
  -H "Content-Type: application/json" \
  -H "AON-Protocol-Version: 1.0" \
  -H "X-AON-Placement-Id: plc_A1b2C3d4E5f6G7h8" \
  -d '{
    "intent": {
      "content": [
        { "type": "input_text", "text": "noise cancelling headphones under $200" }
      ],
      "provenance": "user_expressed",
      "signals": {
        "budget": { "max": 200, "currency": "USD" }
      }
    },
    "context": {
      "platform": { "name": "api-client", "channel": "api" },
      "user_profile": { "country": "US" },
      "session": { "recent_topics": ["headphones"] }
    },
    "constraints": {
      "category_ids": ["computers_electronics.consumer_electronics"]
    },
    "force_offer": false,
    "response_options": { "thinking_mode": true },
    "pagination": { "limit": 5, "offset": 0 }
  }'

Reference provenance and coverage

Services OpenAPI source connected. This page renders from a checked-in services-side OpenAPI artifact, then layers partner-oriented guidance on top of the generated contract.

This checked-in artifact now prioritizes field-level detail for the main developer and partner onboarding routes. Less frequently used endpoints still render from the generated source, but may expose lighter request or response depth until future documentation passes.