Skip to content
 

Your first API call

Send a production Offer Query after the Public Test Sandbox. Replace YOUR_API_KEY with an issued Live Key, send AON-Protocol-Version: 1.0, and read the v1.0 response fields (protocol_version, offers, and any bounded engagement guidance).

Use an issued Live Key owned by a serviceable Application for this route. If you do not have one yet, run the Public Test Sandbox first, then review Production Access & API Keys.

HTTP request shape
curl
curl -s -X POST https://api.aon.pro/v1/offers/query \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "AON-Protocol-Version: 1.0" \
  -d '{
    "intent": {
      "content": [
        { "type": "input_text", "text": "Find travel deals for a weekend trip to Tokyo" }
      ],
      "provenance": "user_expressed"
    },
    "context": {
      "platform": { "name": "api-client", "channel": "api" }
    }
  }' | python3 -m json.tool

What success looks like

The live REST path is complete when an Offer Query with your issued Live Key returns HTTP 2xx, code=SUCCESS, and data.protocol_version="1.0". An empty offers result or data.empty_reason is still a valid successful response. Sandbox, local mock verification, authentication failure, and protocol failure are not live completion.

What to validate

  • Request content and context conform to the v1.0 Query contract.
  • Response handling consumes canonical v1.0 Offer fields and preserves the tracking destination supplied by the integration contract.
  • Keep credentials server-side. For header mechanics, see Authentication.

Review Production Access & API Keys

Review the Offer Query field contract

Local SDK verification

To check client construction without a live endpoint, use SDK setup mock mode. It verifies API shape and error handling only. It does not provide a runtime, credentials, or production eligibility.

Compatibility — existing integration

Existing integrations may continue to use an explicitly supported compatibility path while they plan migration work. New integrations read the canonical v1.0 response; compatibility behavior is not the current contract.

Resources for AI coding agents

Open /agent.md (raw Markdown) for the current Protocol, Schema, and Examples source links behind the request shape.