# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Core Portfolio API
  version: 1.0.0
extends: openapi/uphold-portfolio-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/core/portfolio'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the total portfolio value and holdings
      effect: read
      questions:
      - What is my whole portfolio worth right now and what is in it?
      - Can I see my portfolio total valued in EUR instead of USD?
      instructions:
      - text: Show my portfolio overview.
      - text: Get my portfolio value and holdings in {denomination}.
        slots:
          denomination: query.denomination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/performance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overall portfolio performance
      effect: read
      questions:
      - How much have I gained or lost across my whole portfolio?
      - What is my portfolio's average cost and total invested over a period?
      instructions:
      - text: Show my overall portfolio performance.
      - text: Get total portfolio gains in {denomination} over {interval}.
        slots:
          denomination: query.denomination
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/historical-balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get portfolio balance history
      effect: read
      questions:
      - How has my total portfolio balance changed over time?
      - Can I chart my whole portfolio's available balance over a chosen interval?
      instructions:
      - text: Show my portfolio balance history.
      - text: Chart my total portfolio balance in {denomination} over {interval}.
        slots:
          denomination: query.denomination
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/assets/{asset}/performance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance of one asset I hold
      effect: read
      questions:
      - How is my Bitcoin position performing?
      - What is my average cost and unrealized gain on a single asset?
      instructions:
      - text: Show my performance on {asset}.
        slots:
          asset: path.asset
      - text: Get my unrealized gains on {asset} in {denomination} over {interval}.
        slots:
          asset: path.asset
          denomination: query.denomination
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/assets/_mget/performance'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare performance of several assets I hold
      effect: read
      questions:
      - Can I get gains and losses for several of my assets in one call?
      - How do my BTC, ETH and SOL positions compare?
      instructions:
      - text: Show my performance for the assets {codes}.
        slots:
          codes: requestBody.codes
      - text: Compare my gains across {codes} over {interval}.
        slots:
          codes: requestBody.codes
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/assets/{asset}/historical-balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get balance history for one asset I hold
      effect: read
      questions:
      - How has my balance in a specific asset changed over time?
      - Can I see my holdings of one asset over the last year?
      instructions:
      - text: Show my {asset} balance history.
        slots:
          asset: path.asset
      - text: Chart how much {asset} I held over {interval}.
        slots:
          asset: path.asset
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/accounts/{accountId}/performance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance of one account
      effect: read
      questions:
      - How is one particular account performing?
      - What are the unrealized gains on a single account?
      instructions:
      - text: Show performance for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Get gains for account {accountId} in {denomination} over {interval}.
        slots:
          accountId: path.accountId
          denomination: query.denomination
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/accounts/_mget/performance'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare performance of several accounts
      effect: read
      questions:
      - Can I get performance for several accounts in one request?
      - How do my different accounts compare on gains and losses?
      instructions:
      - text: Show performance for accounts {ids}.
        slots:
          ids: requestBody.ids
      - text: Compare gains across accounts {ids} over {interval}.
        slots:
          ids: requestBody.ids
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/portfolio/accounts/{accountId}/historical-balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get balance history of one account
      effect: read
      questions:
      - How has the balance of one account changed over time?
      - Can I chart a single account's available balance by interval?
      instructions:
      - text: Show the balance history of account {accountId}.
        slots:
          accountId: path.accountId
      - text: Chart account {accountId} balance over {interval}.
        slots:
          accountId: path.accountId
          interval: query.interval
      method: generated
      generated: '2026-09-26'