openapi: 3.1.0
info:
  title: Wolfram|Alpha Fast Query Recognizer Classification Queries API
  description: 'The Wolfram|Alpha Fast Query Recognizer API rapidly classifies a natural language query in under 10 milliseconds to determine whether Wolfram|Alpha is likely to return a useful response. Useful for routing layers that need to decide whether to invoke the heavier Full Results, Short Answers, or LLM APIs. Supports two recognition modes: Default for typed queries and Voice for spoken input.'
  version: '1.0'
  contact:
    name: Wolfram|Alpha Developer Support
    url: https://developer.wolframalpha.com/
  termsOfService: https://products.wolframalpha.com/api/documentation
  x-generated-from: documentation
servers:
- url: https://www.wolframalpha.com/queryrecognizer
  description: Wolfram|Alpha Fast Query Recognizer Server
security:
- AppID: []
tags:
- name: Queries
  description: Submit natural language queries for full computational results
paths:
  /query:
    get:
      operationId: queryFullResults
      summary: Wolfram|Alpha Submit a Full Results Query
      description: Submit a free-form natural language query to the Wolfram|Alpha Full Results API. Returns results in XML (default) or JSON with complete pod data, disambiguations, drilldowns, assumptions, and formatted mathematical/scientific output. Supports asynchronous delivery for long-running computations.
      tags:
      - Queries
      parameters:
      - name: appid
        in: query
        required: true
        description: Wolfram|Alpha AppID for authentication.
        schema:
          type: string
          example: DEMO-APP-ID
        example: DEMO-APP-ID
      - name: input
        in: query
        required: true
        description: URL-encoded natural language query string.
        schema:
          type: string
          example: integrate x^2 from 0 to 1
        example: integrate x^2 from 0 to 1
      - name: output
        in: query
        required: false
        description: Response format. Use json for JSON output; default is XML.
        schema:
          type: string
          enum:
          - xml
          - json
          example: json
        example: json
      - name: format
        in: query
        required: false
        description: 'Comma-separated list of content formats to include in results: image, plaintext, mathml, minput, moutput, cell, sound, wav.'
        schema:
          type: string
          example: plaintext,image
        example: plaintext,image
      - name: includepodid
        in: query
        required: false
        description: Include only pods with these IDs (comma-separated).
        schema:
          type: string
          example: Result
        example: Result
      - name: excludepodid
        in: query
        required: false
        description: Exclude pods with these IDs (comma-separated).
        schema:
          type: string
        example: '500123'
      - name: podtitle
        in: query
        required: false
        description: Include only pods whose title matches this pattern.
        schema:
          type: string
        example: Example Name
      - name: podindex
        in: query
        required: false
        description: Include only pods at these ordinal positions (comma-separated).
        schema:
          type: string
        example: string-value
      - name: scanner
        in: query
        required: false
        description: Include only pods generated by specific scanners.
        schema:
          type: string
        example: string-value
      - name: async
        in: query
        required: false
        description: Use asynchronous delivery for long-running computations.
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
        example: 'true'
      - name: location
        in: query
        required: false
        description: Location name for geographically relevant results.
        schema:
          type: string
          example: New York, NY
        example: New York, NY
      - name: latlong
        in: query
        required: false
        description: Latitude and longitude for location-aware results.
        schema:
          type: string
          example: 40.71,-74.00
        example: 40.71,-74.00
      - name: ip
        in: query
        required: false
        description: IP address for location detection.
        schema:
          type: string
        example: string-value
      - name: units
        in: query
        required: false
        description: Measurement system. Values are metric or imperial.
        schema:
          type: string
          enum:
          - metric
          - imperial
        example: metric
      - name: width
        in: query
        required: false
        description: Width in pixels for image results. Default is 500.
        schema:
          type: integer
          example: 500
        example: 500
      - name: maxwidth
        in: query
        required: false
        description: Maximum width in pixels for images.
        schema:
          type: integer
        example: 1
      - name: mag
        in: query
        required: false
        description: Magnification factor for images.
        schema:
          type: number
        example: 10.5
      - name: timeout
        in: query
        required: false
        description: Maximum processing time in seconds. Default is 5.
        schema:
          type: integer
          example: 5
        example: 5
      - name: assumption
        in: query
        required: false
        description: Assumption values to refine query interpretation.
        schema:
          type: array
          items:
            type: string
        example:
        - string-value
      responses:
        '200':
          description: Successful response with Wolfram|Alpha results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullResultsResponse'
              examples:
                QueryFullResults200Example:
                  summary: Default queryFullResults 200 response
                  x-microcks-default: true
                  value:
                    queryresult:
                      success: true
                      error: false
                      numpods: 2
                      datatypes: Math
                      timing: 0.812
                      pods:
                      - title: Input
                        scanner: Identity
                        id: Input
                        position: 100
                        subpods:
                        - plaintext: integrate x^2 from 0 to 1
                      - title: Result
                        scanner: Integral
                        id: Result
                        position: 200
                        primary: true
                        subpods:
                        - plaintext: 1/3
            application/xml:
              schema:
                type: string
              examples:
                queryFullResults200Example:
                  summary: Default queryFullResults 200 response
                  x-microcks-default: true
                  value: string-value
        '400':
          description: Bad request - required parameters missing.
        '403':
          description: Invalid or missing AppID.
        '501':
          description: Input cannot be interpreted by Wolfram|Alpha.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /llm-api:
    get:
      operationId: queryLlmApi
      summary: Wolfram|Alpha Query the LLM API
      description: Submit a natural language query to the Wolfram|Alpha LLM API. Returns structured text with query interpretation, computed results, relevant data, and a link to the full Wolfram|Alpha results page. Optimized for consumption by large language models and AI chat applications.
      tags:
      - Queries
      parameters:
      - name: appid
        in: query
        required: true
        description: The Wolfram|Alpha AppID used for authentication. Obtain from the Wolfram|Alpha Developer Portal.
        schema:
          type: string
          example: DEMO-APP-ID
        example: DEMO-APP-ID
      - name: input
        in: query
        required: true
        description: URL-encoded natural language query string.
        schema:
          type: string
          example: What is the boiling point of water?
        example: What is the boiling point of water?
      - name: maxchars
        in: query
        required: false
        description: Maximum number of characters in the response. Default is 6800.
        schema:
          type: integer
          example: 5000
        example: 5000
      - name: assumption
        in: query
        required: false
        description: Assumption values to refine query interpretation.
        schema:
          type: array
          items:
            type: string
        example:
        - string-value
      - name: ip
        in: query
        required: false
        description: IP address of the query origin for location-aware results.
        schema:
          type: string
          example: 192.0.2.1
        example: 192.0.2.1
      - name: latlong
        in: query
        required: false
        description: Latitude and longitude for location-based queries (e.g., 40.71,-74.00).
        schema:
          type: string
          example: 40.71,-74.00
        example: 40.71,-74.00
      - name: timezone
        in: query
        required: false
        description: IANA timezone name for the query context.
        schema:
          type: string
          example: America/New_York
        example: America/New_York
      - name: units
        in: query
        required: false
        description: Measurement system preference. Values are metric or imperial.
        schema:
          type: string
          enum:
          - metric
          - imperial
          example: metric
        example: metric
      - name: currency
        in: query
        required: false
        description: ISO 4217 currency code for financial queries.
        schema:
          type: string
          example: USD
        example: USD
      - name: languagecode
        in: query
        required: false
        description: BCP 47 language code for query input and response.
        schema:
          type: string
          example: en
        example: en
      - name: formattimeout
        in: query
        required: false
        description: Maximum processing time in seconds before timeout.
        schema:
          type: integer
          example: 5
        example: 5
      responses:
        '200':
          description: Successful response with computational results from Wolfram|Alpha.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LlmApiResponse'
              examples:
                QueryLlmApi200Example:
                  summary: Default queryLlmApi 200 response
                  x-microcks-default: true
                  value:
                    query: What is the boiling point of water?
                    inputInterpretation: boiling point | water
                    result: 100 degrees Celsius (at standard atmospheric pressure)
                    images: []
                    link: https://www.wolframalpha.com/input?i=boiling+point+water
            text/plain:
              schema:
                type: string
              examples:
                queryLlmApi200Example:
                  summary: Default queryLlmApi 200 response
                  x-microcks-default: true
                  value: string-value
        '400':
          description: Bad request - input parameter is missing or invalid.
        '403':
          description: Invalid or missing AppID.
        '501':
          description: Input cannot be interpreted by the Wolfram|Alpha engine.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /result:
    get:
      operationId: queryShortAnswer
      summary: Wolfram|Alpha Get Short Answer
      description: Submit a natural language query and receive a single concise plain-text answer. Suitable for chatbots, voice assistants, and constrained display contexts. Returns HTTP 501 when the query has no short answer.
      tags:
      - Queries
      parameters:
      - name: appid
        in: query
        required: true
        description: Wolfram|Alpha AppID for authentication.
        schema:
          type: string
          example: DEMO-APP-ID
        example: DEMO-APP-ID
      - name: i
        in: query
        required: true
        description: URL-encoded input query string.
        schema:
          type: string
          example: How far is the Moon from Earth?
        example: How far is the Moon from Earth?
      - name: units
        in: query
        required: false
        description: Measurement system preference. Values are metric or imperial.
        schema:
          type: string
          enum:
          - metric
          - imperial
          example: metric
        example: metric
      - name: timeout
        in: query
        required: false
        description: Maximum processing time in seconds. Default is 5.
        schema:
          type: integer
          example: 5
        example: 5
      responses:
        '200':
          description: Successful short text answer.
          content:
            text/plain:
              schema:
                type: string
                description: Single plain-text answer from Wolfram|Alpha.
                example: 384,400 kilometers
              examples:
                QueryShortAnswer200Example:
                  summary: Default queryShortAnswer 200 response
                  x-microcks-default: true
                  value: 384,400 kilometers
        '400':
          description: Bad request - input parameter missing or invalid.
        '403':
          description: Invalid or missing AppID.
        '501':
          description: Input cannot be interpreted or no short answer available.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /simple:
    get:
      operationId: querySimpleApi
      summary: Wolfram|Alpha Get Simple Image Result
      description: Submit a natural language query and receive the complete Wolfram|Alpha result rendered as a static image. Customizable background, foreground, font size, and width. Does not support disambiguation, drilldown, or asynchronous delivery.
      tags:
      - Queries
      parameters:
      - name: appid
        in: query
        required: true
        description: Wolfram|Alpha AppID for authentication.
        schema:
          type: string
          example: DEMO-APP-ID
        example: DEMO-APP-ID
      - name: i
        in: query
        required: true
        description: URL-encoded input query string.
        schema:
          type: string
          example: mass of the sun
        example: mass of the sun
      - name: layout
        in: query
        required: false
        description: Content presentation style. Values are divider (default) or labelbar.
        schema:
          type: string
          enum:
          - divider
          - labelbar
          example: divider
        example: divider
      - name: background
        in: query
        required: false
        description: Image background color as HTML color name, hex value, or RGB value.
        schema:
          type: string
          example: white
        example: white
      - name: foreground
        in: query
        required: false
        description: Text color. Values are black (default) or white.
        schema:
          type: string
          enum:
          - black
          - white
          example: black
        example: black
      - name: fontsize
        in: query
        required: false
        description: Font size in points for rendered text. Default is 14.
        schema:
          type: integer
          example: 14
        example: 14
      - name: width
        in: query
        required: false
        description: Image width in pixels. Default is 500.
        schema:
          type: integer
          example: 500
        example: 500
      - name: units
        in: query
        required: false
        description: Measurement system preference. Values are metric or imperial.
        schema:
          type: string
          enum:
          - metric
          - imperial
        example: metric
      - name: timeout
        in: query
        required: false
        description: Maximum processing time in seconds. Default is 5.
        schema:
          type: integer
          example: 5
        example: 5
      responses:
        '200':
          description: Rendered image of Wolfram|Alpha results.
          content:
            image/gif:
              schema:
                type: string
                format: binary
                description: GIF image of the rendered Wolfram|Alpha result.
              examples:
                querySimpleApi200Example:
                  summary: Default querySimpleApi 200 response
                  x-microcks-default: true
                  value: string-value
        '400':
          description: Bad request - input parameter missing or invalid.
        '403':
          description: Invalid or missing AppID.
        '501':
          description: Input cannot be interpreted by Wolfram|Alpha.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /spoken:
    get:
      operationId: querySpokenResults
      summary: Wolfram|Alpha Get Spoken Result
      description: Submit a natural language query and receive a plain-text answer formatted for audio delivery. Results are phrased naturally for text-to-speech conversion, suitable for voice assistants, automotive applications, and accessibility features.
      tags:
      - Queries
      parameters:
      - name: appid
        in: query
        required: true
        description: Wolfram|Alpha AppID for authentication.
        schema:
          type: string
          example: DEMO-APP-ID
        example: DEMO-APP-ID
      - name: i
        in: query
        required: true
        description: URL-encoded input query string.
        schema:
          type: string
          example: How tall is Mount Everest?
        example: How tall is Mount Everest?
      - name: units
        in: query
        required: false
        description: Measurement system preference. Values are metric or imperial.
        schema:
          type: string
          enum:
          - metric
          - imperial
          example: imperial
        example: imperial
      - name: timeout
        in: query
        required: false
        description: Maximum processing time in seconds. Default is 5.
        schema:
          type: integer
          example: 5
        example: 5
      responses:
        '200':
          description: Spoken-text formatted answer from Wolfram|Alpha.
          content:
            text/plain:
              schema:
                type: string
                description: Plain-text answer formatted for audio delivery.
                example: Mount Everest is approximately 29,032 feet or about 8,849 meters tall.
              examples:
                QuerySpokenResults200Example:
                  summary: Default querySpokenResults 200 response
                  x-microcks-default: true
                  value: Mount Everest is approximately 29,032 feet or about 8,849 meters tall.
        '400':
          description: Bad request - input parameter missing or invalid.
        '403':
          description: Invalid or missing AppID.
        '501':
          description: Input cannot be interpreted or no spoken result available.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    LlmApiResponse:
      type: object
      title: LlmApiResponse
      description: Response from the Wolfram|Alpha LLM API containing computed results.
      properties:
        query:
          type: string
          description: The original query that was submitted.
          example: What is the boiling point of water?
        inputInterpretation:
          type: string
          description: Wolfram|Alpha's interpretation of the input query.
          example: boiling point | water
        result:
          type: string
          description: The primary computed result for the query.
          example: 100 degrees Celsius (at standard atmospheric pressure)
        images:
          type: array
          items:
            type: string
            format: uri
          description: List of image URLs related to the query results.
          example:
          - https://example.com/path
        link:
          type: string
          format: uri
          description: URL to the full Wolfram|Alpha results page for this query.
          example: https://www.wolframalpha.com/input?i=boiling+point+water
    FullResultsResponse:
      type: object
      title: FullResultsResponse
      description: JSON wrapper for Wolfram|Alpha Full Results API response.
      properties:
        queryresult:
          type: object
          description: Top-level query result container.
          properties:
            success:
              type: boolean
              description: Whether the query was successfully interpreted.
              example: true
            error:
              type: boolean
              description: Whether an error occurred during processing.
              example: false
            numpods:
              type: integer
              description: Number of result pods returned.
              example: 2
            datatypes:
              type: string
              description: Categories of data types included in the results.
              example: Math
            timing:
              type: number
              description: Processing time in seconds.
              example: 0.812
            pods:
              type: array
              description: Array of result pods containing computed data.
              items:
                $ref: '#/components/schemas/Pod'
          example:
            success: true
            error: false
            numpods: 2
            datatypes: Math
            timing: 0.812
            pods:
            - string-value
    Subpod:
      type: object
      title: Subpod
      description: A sub-result within a Wolfram|Alpha pod.
      properties:
        plaintext:
          type: string
          description: Plain text representation of the result.
          example: 1/3
        img:
          type: object
          description: Image representation of the result.
          properties:
            src:
              type: string
              format: uri
              description: URL of the result image.
            alt:
              type: string
              description: Alt text for the result image.
            width:
              type: integer
            height:
              type: integer
          example:
            src: https://example.com/path
            alt: string-value
            width: 1
            height: 1
    Pod:
      type: object
      title: Pod
      description: A single result section (pod) from Wolfram|Alpha.
      properties:
        title:
          type: string
          description: Human-readable title for this pod.
          example: Result
        scanner:
          type: string
          description: Internal scanner that generated this pod.
          example: Integral
        id:
          type: string
          description: Pod identifier for filtering.
          example: Result
        position:
          type: integer
          description: Ordering position in the result set.
          example: 200
        primary:
          type: boolean
          description: Whether this is the primary result pod.
          example: true
        subpods:
          type: array
          description: Sub-results within this pod.
          items:
            $ref: '#/components/schemas/Subpod'
          example:
          - string-value
  securitySchemes:
    AppID:
      type: apiKey
      in: query
      name: appid
      description: Wolfram|Alpha AppID passed as query parameter.