# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for REST Orders API
  version: 1.0.0
extends: openapi/gemini-trust-orders-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/v1/order/new'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a new exchange limit order
      effect: write
      questions:
      - How do I place a limit order to buy bitcoin at a set price?
      - Can I place a stop-limit order or a maker-only order?
      - Is it possible to place an exchange order on my margin account?
      instructions:
      - text: Place a limit order to {side} {amount} {symbol} at {price}.
        slots:
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          price: requestBody.price
      - text: Place a stop-limit {side} of {amount} {symbol} at {price} triggered at {stop_price}.
        slots:
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          price: requestBody.price
          stop_price: requestBody.stop_price
      - text: Submit order {client_order_id} to {side} {amount} {symbol} at {price} with options {options}.
        slots:
          client_order_id: requestBody.client_order_id
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          price: requestBody.price
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/order/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel one exchange order
      effect: destructive
      questions:
      - Can I cancel a single open order by its order ID?
      - What happens if I cancel an order that's already canceled?
      instructions:
      - text: Cancel exchange order {order_id}.
        slots:
          order_id: requestBody.order_id
      - text: Cancel order {order_id} on account {account}.
        slots:
          order_id: requestBody.order_id
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/order/cancel/all'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel every open order on the account
      effect: destructive
      questions:
      - How do I cancel all my open orders at once, including ones placed in the web UI?
      - Is there a kill switch that clears every outstanding order across all sessions?
      instructions:
      - text: Cancel all outstanding orders across every session.
      - text: Clear every active order on account {account}.
        slots:
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/order/cancel/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel orders opened by this API session
      effect: destructive
      questions:
      - Can I cancel only the orders this API session opened and leave the rest?
      - Is cancelling session orders the same as letting the heartbeat expire?
      instructions:
      - text: Cancel only the orders opened by this API session.
      - text: Cancel this session's orders on account {account}.
        slots:
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/order/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an exchange order
      effect: read
      questions:
      - Has my order filled yet, or is it still open?
      - Can I look up an order by the client order ID I assigned?
      instructions:
      - text: Get the status of order {order_id}.
        slots:
          order_id: requestBody.order_id
      - text: Show order {order_id} along with its trades.
        slots:
          order_id: requestBody.order_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: List my open exchange orders
      effect: read
      questions:
      - Which of my exchange orders are still open?
      - What limit orders are resting on the book for my account?
      instructions:
      - text: List my open exchange orders.
      - text: Show active orders for account {account}.
        slots:
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orders/history'].post
  update:
    x-apievangelist-phrasing:
      intent: List closed exchange orders
      effect: read
      questions:
      - Where can I see orders that have already closed?
      - Can I pull closed order history for one pair from a given date?
      instructions:
      - text: List my closed {symbol} orders.
        slots:
          symbol: requestBody.symbol
      - text: Show up to {limit_orders} closed orders since {timestamp}.
        slots:
          limit_orders: requestBody.limit_orders
          timestamp: requestBody.timestamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/mytrades'].post
  update:
    x-apievangelist-phrasing:
      intent: List my executed trades
      effect: read
      questions:
      - What trades have I executed on ETHUSD?
      - Can I get my own fill history since a timestamp?
      instructions:
      - text: List my executed trades on {symbol}.
        slots:
          symbol: requestBody.symbol
      - text: Show my last {limit_trades} fills since {timestamp}.
        slots:
          limit_trades: requestBody.limit_trades
          timestamp: requestBody.timestamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tradevolume'].post
  update:
    x-apievangelist-phrasing:
      intent: Get my trading volume by symbol
      effect: read
      questions:
      - How much have I traded in each pair recently?
      - Can I see my trading volume broken out per symbol?
      instructions:
      - text: Show my trading volume per symbol.
      - text: Get trading volume for account {account}.
        slots:
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/notionalvolume'].post
  update:
    x-apievangelist-phrasing:
      intent: Get notional volume and fee tier
      effect: read
      questions:
      - What is my notional trading volume across the exchange?
      - Are there fee promotions on a specific pair for my account?
      instructions:
      - text: Show my notional trading volume.
      - text: Check fee promotions on {symbol} for account {account}.
        slots:
          symbol: requestBody.symbol
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/wrap/{symbol}'].post
  update:
    x-apievangelist-phrasing:
      intent: Wrap or unwrap an asset
      effect: write
      questions:
      - How do I wrap an asset into its wrapped token on the exchange?
      - Can I unwrap by placing a sell on the wrap pair?
      instructions:
      - text: Wrap {amount} on the {symbol} pair.
        slots:
          amount: requestBody.amount
          symbol: path.symbol
      - text: Place a {side} wrap order for {amount} {symbol} with id {client_order_id}.
        slots:
          side: requestBody.side
          amount: requestBody.amount
          symbol: path.symbol
          client_order_id: requestBody.client_order_id
      method: generated
      generated: '2026-10-01'