Examples

{
  "awp_version": "0.1",
  "domain": "skyways.com",
  "intent": "Skyways Airlines — search flights, book tickets, check in, and select seats. Agents can help travelers find the best routes and fares across 200+ destinations.",
  "capabilities": {
    "streaming": false,
    "batch_actions": true,
    "webhooks": true,
    "pagination": "cursor",
    "idempotency": true
  },
  "auth": {
    "required_for": ["book_flight", "check_in", "select_seat"],
    "optional_for": ["search_flights"],
    "type": "oauth2",
    "token_expiry": "24h",
    "refresh_endpoint": "/api/auth/refresh"
  },
  "entities": {
    "flight": {
      "fields": {
        "flight_number": "string",
        "origin": "airport_code",
        "destination": "airport_code",
        "departure_time": "ISO8601",
        "price_usd": "float",
        "cabin_class": "enum[economy, business, first]"
      }
    },
    "booking": {
      "fields": {
        "booking_ref": "string",
        "flight_number": "string",
        "passenger_name": "string",
        "status": "enum[confirmed, cancelled, checked_in]"
      }
    }
  },
  "actions": [
    {
      "id": "search_flights",
      "description": "Search available flights between two airports on a given date",
      "auth_required": false,
      "inputs": {
        "origin": { "type": "airport_code", "required": true },
        "destination": { "type": "airport_code", "required": true },
        "date": { "type": "ISO8601", "required": true },
        "cabin_class": {
          "type": "enum",
          "options": ["economy", "business", "first"],
          "default": "economy"
        }
      },
      "outputs": {
        "flights": "array[flight]",
        "search_token": "string"
      },
      "endpoint": "/api/flights/search",
      "method": "POST",
      "rate_limit": "30/minute",
      "idempotency": {
        "supported": true,
        "key_field": "idempotency_key",
        "window": "24h"
      },
      "execution_model": "sync"
    },
    {
      "id": "book_flight",
      "description": "Book a flight for one or more passengers",
      "auth_required": true,
      "inputs": {
        "flight_number": { "type": "string", "required": true },
        "passengers": { "type": "array[object]", "required": true },
        "payment_token": { "type": "string", "required": true }
      },
      "outputs": {
        "booking": "object[booking]"
      },
      "endpoint": "/api/bookings",
      "method": "POST",
      "sensitivity": "destructive",
      "requires_human_confirmation": true,
      "reversible": true,
      "execution_model": "sync"
    },
    {
      "id": "check_in",
      "description": "Check in for a flight using booking reference",
      "auth_required": true,
      "inputs": {
        "booking_ref": { "type": "string", "required": true }
      },
      "outputs": {
        "boarding_pass": "object",
        "gate": "string"
      },
      "endpoint": "/api/checkin",
      "method": "POST",
      "sensitivity": "standard",
      "execution_model": "sync"
    },
    {
      "id": "select_seat",
      "description": "Select a seat assignment for a booking",
      "auth_required": true,
      "inputs": {
        "booking_ref": { "type": "string", "required": true },
        "seat": { "type": "string", "required": true, "description": "Seat code e.g. 12A" }
      },
      "outputs": {
        "confirmed_seat": "string"
      },
      "endpoint": "/api/bookings/{booking_ref}/seat",
      "method": "PUT",
      "execution_model": "sync"
    }
  ],
  "errors": {
    "AUTH_EXPIRED": {
      "recovery": "call /api/auth/refresh then retry original action"
    },
    "RATE_LIMITED": {
      "recovery": "wait 60 seconds then retry"
    },
    "SEAT_UNAVAILABLE": {
      "recovery": "retry search_flights with different parameters"
    },
    "INVALID_AIRPORT_CODE": {
      "recovery": "query /api/airports?search={input} to find valid codes"
    }
  },
  "dependencies": {
    "book_flight": ["search_flights"],
    "check_in": ["book_flight"],
    "select_seat": ["book_flight"]
  },
  "agent_hints": {
    "optimal_search_window": "search at least 24h before departure",
    "price_volatility": "high — cache search results max 5 minutes",
    "auth_note": "search does not require auth — only call auth when booking"
  },
  "agent_status": {
    "operational": true,
    "degraded_actions": [],
    "status_endpoint": "/api/status"
  }
}