Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Uphold Assets API

14 actions 14 updates phrasing extends openapi/uphold-assets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Uphold's API. It is a proposal applied on top of the contract, not a document Uphold publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 14

$.info
$.paths['/core/assets'].get
$.paths['/core/assets/_mget'].post
$.paths['/core/assets/{asset}'].get
$.paths['/core/assets/{asset}/rates'].get
$.paths['/core/assets/{asset}/historical-rates'].get
$.paths['/core/networks'].get
$.paths['/core/networks/{network}'].get
$.paths['/core/networks/{network}/validate-address'].post
$.paths['/core/rails'].get
$.paths['/core/assets/test-helpers/skip-assets-cooldowns'].put
$.paths['/market-pulse/assets/{assetCode}/news'].get
$.paths['/market-pulse/assets/{assetCode}/statistics'].get
$.paths['/market-pulse/assets/{assetCode}/information'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Uphold Assets API
  version: 1.0.0
extends: openapi/uphold-assets-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: 13
- target: $.paths['/core/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported assets
      effect: read
      questions:
      - Which assets and currencies does Uphold support?
      - Can I filter the supported asset list to just cryptocurrencies?
      - Is there a way to sort the list of supported assets?
      instructions:
      - text: List every supported asset.
      - text: Show supported assets of type {type}, sorted by {sort}.
        slots:
          type: query.type
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/assets/_mget'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up several assets by code at once
      effect: read
      questions:
      - Can I fetch details for several asset codes in a single request?
      - How do I look up BTC, ETH and USD together?
      instructions:
      - text: Get asset details for the codes {codes}.
        slots:
          codes: requestBody.codes
      - text: 'Look up these assets in one batch: {codes}.'
        slots:
          codes: requestBody.codes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/assets/{asset}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one asset
      effect: read
      questions:
      - What details are available for a single asset code?
      - How do I check the settings of one specific asset?
      instructions:
      - text: Get the asset {asset}.
        slots:
          asset: path.asset
      - text: Show me the platform details for {asset}.
        slots:
          asset: path.asset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/assets/{asset}/rates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current exchange rates for an asset
      effect: read
      questions:
      - What is the current exchange rate of an asset against other assets?
      - Can I get an asset's rate only against USD and EUR?
      instructions:
      - text: Get current rates for {asset}.
        slots:
          asset: path.asset
      - text: Show the current {asset} rate in {denomination}.
        slots:
          asset: path.asset
          denomination: query.denomination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/assets/{asset}/historical-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get historical price history for an asset
      effect: read
      questions:
      - How has an asset's price moved over time?
      - Can I pull historical rates for an asset over a chosen interval?
      instructions:
      - text: Get historical rates for {asset}.
        slots:
          asset: path.asset
      - text: Chart {asset} price history in {denomination} over {interval}.
        slots:
          asset: path.asset
          denomination: query.denomination
          interval: query.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported networks
      effect: read
      questions:
      - Which blockchain and payment networks are supported?
      - Can I list only networks of a certain type?
      instructions:
      - text: List all supported networks.
      - text: Show supported networks of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/networks/{network}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one network
      effect: read
      questions:
      - What information is available about a specific network like Ethereum?
      - How do I look up one network by its code?
      instructions:
      - text: Get the network {network}.
        slots:
          network: path.network
      - text: Show me details for the {network} network.
        slots:
          network: path.network
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/networks/{network}/validate-address'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if an address is valid on a network
      effect: read
      questions:
      - How do I check whether a wallet address is valid before sending funds?
      - Can I verify an address together with its memo or destination tag?
      instructions:
      - text: Validate address {address} on the {network} network.
        slots:
          address: requestBody.address
          network: path.network
      - text: Check if {address} with reference {reference} is valid on {network}.
        slots:
          address: requestBody.address
          reference: requestBody.reference
          network: path.network
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/rails'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported payment rails
      effect: read
      questions:
      - Which payment rails can move money in or out of the platform?
      - What rails are available for a specific asset and network?
      instructions:
      - text: List all supported rails.
      - text: Show rails for {asset} on {network} using method {method}.
        slots:
          asset: query.asset
          network: query.network
          method: query.method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/assets/test-helpers/skip-assets-cooldowns'].put
  update:
    x-apievangelist-phrasing:
      intent: Skip asset cooldowns in testing
      effect: write
      questions:
      - How do I bypass asset cooldown periods while testing?
      - Is there a test helper to clear asset cooldowns?
      instructions:
      - text: Skip all asset cooldowns in the test environment.
      - text: Clear asset cooldowns so I can keep testing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/market-pulse/assets/{assetCode}/news'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest news for an asset
      effect: read
      questions:
      - What is the latest news about a particular crypto asset?
      - Can I limit how many news articles come back for one asset?
      instructions:
      - text: Show the latest news about {assetCode}.
        slots:
          assetCode: path.assetCode
      - text: Get the {limit} most recent articles about {assetCode}.
        slots:
          limit: query.limit
          assetCode: path.assetCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/market-pulse/assets/{assetCode}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get live market statistics for an asset
      effect: read
      questions:
      - What are the real-time market statistics for an asset?
      - How do I see an asset's live market stats such as market cap and volume?
      instructions:
      - text: Get market statistics for {assetCode}.
        slots:
          assetCode: path.assetCode
      - text: Show live market stats for {assetCode}.
        slots:
          assetCode: path.assetCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/market-pulse/assets/{assetCode}/information'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a description of an asset
      effect: read
      questions:
      - Where can I get a written description of what an asset is?
      - Can I get an asset's descriptive information in a different language or format?
      instructions:
      - text: Describe the asset {assetCode}.
        slots:
          assetCode: path.assetCode
      - text: Get information about {assetCode} in {format} format.
        slots:
          assetCode: path.assetCode
          format: query.format
      method: generated
      generated: '2026-09-26'