> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asobeast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Inspect any keyword in one storefront

> Queues a live inspection of a keyword the workspace does not need to track: the top 50 search results, the store autocomplete, popularity, difficulty and opportunity with their source and confidence, and a competition summary of the top 10. Answers at once with the pending inspection; poll GET /keyword-inspections/{id} until status is DONE or FAILED. An inspection of the same keyword and storefront that is still pending is answered instead of queuing another. A queued inspection spends one on demand score of the daily allowance; a request the validation refuses, a repeat of a pending inspection and an inspection that could not be queued spend nothing.



## OpenAPI

````yaml /api-reference/openapi.json post /keyword-inspections
openapi: 3.0.0
info:
  title: asobeast API
  description: >-
    Self-hosted ASO toolkit API. It tracks the apps you import and their
    competitors over time and reads what AsoBeast collected; it is not a bulk
    store lookup.


    A metered instance carries RateLimit-Limit, RateLimit-Remaining and
    RateLimit-Reset on every response, for the tightest limit the request
    touched. A self-hosted instance has no request rate limits and sends no such
    header. Limits are per workspace, so minting more tokens does not buy more
    capacity, and they are sized per plan across three classes: read for stored
    data, write for configuration changes and store for the endpoints that reach
    the App Store or Google Play.


    A 429 carries Retry-After and a rateLimit object naming the window that
    closed, or an aiAllowance object when the workspace has spent the AI calls
    its plan includes this month. A 403 with a quota object means a plan
    capacity limit such as apps or tracked keyword markets, which is a different
    problem from a rate limit. A 402 with an entitlement object means the
    workspace needs a plan.


    Positions are 1-based and null means checked but not found within the
    captured depth, never zero. Daily granularity uses UTC dates.
  version: 1.16.0
  contact: {}
servers:
  - url: http://localhost:3000/api/backend
    description: Web origin proxy
  - url: http://localhost:4000
    description: Direct API
security:
  - personalApiToken: []
tags: []
paths:
  /keyword-inspections:
    post:
      tags:
        - keyword-inspections
      summary: Inspect any keyword in one storefront
      description: >-
        Queues a live inspection of a keyword the workspace does not need to
        track: the top 50 search results, the store autocomplete, popularity,
        difficulty and opportunity with their source and confidence, and a
        competition summary of the top 10. Answers at once with the pending
        inspection; poll GET /keyword-inspections/{id} until status is DONE or
        FAILED. An inspection of the same keyword and storefront that is still
        pending is answered instead of queuing another. A queued inspection
        spends one on demand score of the daily allowance; a request the
        validation refuses, a repeat of a pending inspection and an inspection
        that could not be queued spend nothing.
      operationId: KeywordInspectionsController_request
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestKeywordInspectionDto'
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    RequestKeywordInspectionDto:
      type: object
      properties:
        keyword:
          type: string
          maxLength: 80
          example: habit tracker
        store:
          enum:
            - APP_STORE
            - GOOGLE_PLAY
          type: string
        country:
          type: string
          example: us
          pattern: ^[a-z]{2}$
      required:
        - keyword
        - store
        - country
  securitySchemes:
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.