Upstox · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI definition IPO API

7 actions 7 updates phrasing extends openapi/upstox-ipo-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Upstox's API. It is a proposal applied on top of the contract, not a document Upstox publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/v2/ipos/orders'].get

$.paths['/v2/ipos/orders'].post

$.paths['/v2/ipos'].get

$.paths['/v2/ipos/{id}'].get

$.paths['/v2/ipos/orders/{order_id}'].get

$.paths['/v2/ipos/orders/{order_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAPI definition IPO API
  version: 1.0.0
extends: openapi/upstox-ipo-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: 6
- target: $.paths['/v2/ipos/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List my IPO applications
      effect: read
      questions:
      - Which IPOs have I applied for?
      - Where can I see the status of all my IPO applications?
      instructions:
      - text: List my IPO applications.
      - text: Show page {page_number} of my IPO orders, {records} per page.
        slots:
          page_number: query.page_number
          records: query.records
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/ipos/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply for an IPO
      effect: write
      questions:
      - How do I apply for an upcoming IPO with my UPI ID?
      - Can I place more than one bid in a single IPO application?
      - What investor category should I choose when bidding in an IPO?
      instructions:
      - text: Apply for IPO {id} as {category} using UPI {upi} with bids {bids}.
        slots:
          id: requestBody.id
          category: requestBody.category
          upi: requestBody.upi
          bids: requestBody.bids
      - text: Submit an application to {id} under category {category}, blocking funds via {upi}, bidding {bids}.
        slots:
          id: requestBody.id
          category: requestBody.category
          upi: requestBody.upi
          bids: requestBody.bids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/ipos'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse IPOs by status
      effect: read
      questions:
      - What IPOs are open right now?
      - Can I list only SME issues or only mainboard IPOs?
      - Which upcoming IPOs are there on Upstox?
      instructions:
      - text: List IPOs with status {status}.
        slots:
          status: query.status
      - text: Show {issue_type} IPOs that are {status}.
        slots:
          issue_type: query.issue_type
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/ipos/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an IPO
      effect: read
      questions:
      - What is the price band, lot size and dates for a particular IPO?
      - Which investor categories can bid in a given IPO?
      instructions:
      - text: Get the details of IPO {id}.
        slots:
          id: path.id
      - text: Show price band, dates and categories for IPO {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/ipos/orders/{order_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one IPO application
      effect: read
      questions:
      - What is the status of the IPO application I just submitted?
      - Has my mandate been accepted for a specific IPO application?
      instructions:
      - text: Check IPO application {order_id}.
        slots:
          order_id: path.order_id
      - text: Show the bids and status of IPO order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/ipos/orders/{order_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an IPO application
      effect: destructive
      questions:
      - Can I withdraw an IPO application after submitting it?
      - How do I cancel an IPO bid before the issue closes?
      instructions:
      - text: Cancel IPO application {order_id}.
        slots:
          order_id: path.order_id
      - text: Withdraw my IPO order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'