api-stock-com Catalog API

openapi: 3.2.0
info:
  title: Stock Com Catalog API
  version: '1.0'
  contact: {}
  description: 'Operations tagged Catalog across 2 of this provider''s published API definitions: api-stock-com-openapi.json, api-stock-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.api-stock.com
  description: Production
tags:
- name: Catalog
paths:
  /api/v1/catalog:
    get:
      description: Models with display metadata, price table and the input parameter schema derived from each model's DTO.
      operationId: CatalogController_getCatalog
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CatalogModelDto'
      summary: Get the public model catalog
      tags:
      - Catalog
    servers:
    - url: https://api.api-stock.com
      description: Production
  /api/v1/catalog/exchange-rate/{currency}:
    get:
      operationId: CatalogController_getExchangeRate
      parameters:
      - name: currency
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogExchangeRateDto'
        '404':
          description: Currency not published
        '503':
          description: No rate available
      summary: Get the USD exchange rate used for local prices
      tags:
      - Catalog
    servers:
    - url: https://api.api-stock.com
      description: Production
  /api/v1/catalog/{id}:
    get:
      operationId: CatalogController_getModel
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogModelDto'
        '404':
          description: Model not found
      summary: Get one catalog entry by model id
      tags:
      - Catalog
    servers:
    - url: https://api.api-stock.com
      description: Production
components:
  schemas:
    CatalogParamOptionDto:
      type: object
      properties:
        value:
          description: Value sent to the API
          oneOf:
          - type: string
          - type: number
        label:
          type: string
          description: Human-readable label
      required:
      - value
      - label
    CatalogModelDto:
      type: object
      properties:
        pageUpdatedAt:
          type: string
          description: Observed significant public content change, ISO 8601; omitted until a change is recorded
        id:
          type: string
          description: Public model id, also used as the URL slug
        group:
          type: string
          description: Routing group shared by related models
        name:
          type: string
          description: Display name
        description:
          type: string
          description: Marketing description
        descriptionLocales:
          type: object
          additionalProperties:
            type: string
          description: 'Marketing descriptions keyed by locale, for example { en: "…", ru: "…" }'
        type:
          type: string
          description: Generation type
          enum:
          - TEXT
          - MUSIC
          - IMAGE
          - VIDEO
        kind:
          type: string
          description: Media generation model or LLM chat model
          enum:
          - media
          - llm
        vendor:
          type: string
          description: Upstream vendor, e.g. Google
        releasedAt:
          type: string
          description: Date the vendor released the model, `YYYY-MM-DD`; absent when never announced
          example: '2026-07-31'
        tags:
          description: Catalog tags
          type: array
          items:
            type: string
        capabilities:
          description: Capability tags derived from the model's parameters
          type: array
          items:
            type: string
        pricing:
          description: Price table; empty when the model has no published price
          type: array
          items:
            $ref: '#/components/schemas/CatalogPriceDto'
        priceFrom:
          type: string
          description: 'Headline price in USD, in the same unit as `pricing` (see `priceUnit`): the base-tier price for media models (or the cheapest complete tariff variant when no base tier resolves), the input-token rate for chat models'
        priceUnit:
          type: string
          description: 'What one price in `pricing` and `priceFrom` buys: a whole generation, one second of output (per-second video tariffs) or 1M tokens (chat models)'
          enum:
          - generation
          - second
          - megatoken
        params:
          description: Input parameters, in the order the form should render them
          type: array
          items:
            $ref: '#/components/schemas/CatalogParamFieldDto'
        protocols:
          type: array
          description: Wire protocols available for an LLM model
          items:
            type: string
            enum:
            - openai
            - anthropic
      required:
      - id
      - group
      - name
      - type
      - kind
      - tags
      - capabilities
      - pricing
      - priceUnit
      - params
    CatalogExchangeRateDto:
      type: object
      properties:
        baseCurrency:
          type: string
          example: USD
        currency:
          type: string
          example: RUB
        rate:
          type: number
          example: 81.37
          description: Units of `currency` per one USD
        rateUpdatedAt:
          type: string
          description: When the rate provider last updated this rate (ISO 8601)
      required:
      - baseCurrency
      - currency
      - rate
      - rateUpdatedAt
    CatalogPriceDto:
      type: object
      properties:
        key:
          type: string
          description: Cost key from the model catalog ("default", a resolution, a size…)
        price:
          type: string
          description: Price in USD, as a string, for one unit of `CatalogModelDto.priceUnit` — a whole generation, one second of output or 1M tokens
        isDefault:
          type: boolean
          description: 'Whether this is the model''s base tier: what a request that sets no parameters is billed'
        dimensions:
          type: object
          additionalProperties:
            type: string
          description: Resolved tariff dimensions for this price; present for matrix tariffs
      required:
      - key
      - price
      - isDefault
    CatalogParamFieldDto:
      type: object
      properties:
        name:
          type: string
          description: Field name as sent in `input`
        label:
          type: string
          description: Label for the form control
        description:
          type: string
          description: Field description
        kind:
          type: string
          description: Scalar kind of the field (of its items when `isArray`)
          enum:
          - string
          - number
          - boolean
          - object
        isArray:
          type: boolean
          description: Whether the field accepts a list of values
        required:
          type: boolean
          description: Whether the field is mandatory
        default:
          description: Default value, if any
          oneOf:
          - type: string
          - type: number
          - type: boolean
          - type: array
            items: {}
        options:
          description: Allowed values — render as a select
          type: array
          items:
            $ref: '#/components/schemas/CatalogParamOptionDto'
        minimum:
          type: number
        maximum:
          type: number
        maxLength:
          type: number
        isMedia:
          type: boolean
          description: Field holds a URL of user-supplied media
        isPrompt:
          type: boolean
          description: Field is the model's main prompt
        multiline:
          type: boolean
          description: Render as a textarea rather than an input
        deprecated:
          type: boolean
          description: Field is kept for compatibility only
      required:
      - name
      - label
      - kind
      - isArray
      - required
      - isMedia
      - isPrompt
      - multiline
      - deprecated
  securitySchemes:
    apiKey:
      scheme: bearer
      bearerFormat: API Key
      type: http
      description: Enter your API key
externalDocs:
  description: API Stock documentation
  url: https://docs.api-stock.com
x-refined-from:
- api-stock-com-openapi.json
- api-stock-com-openapi.json