AnomalyArmor Public Intelligence API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai Public Intelligence API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged public-intelligence across 3 of this provider''s published API definitions: anomalyarmor.ai-openapi.json, app.anomalyarmor.ai-openapi.json, docs.anomalyarmor.ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8000
  description: Development server
- url: https://api.anomalyarmor.ai
  description: Production server
tags:
- name: public-intelligence
paths:
  /api/v1/sdk/intelligence/ask:
    post:
      tags:
      - public-intelligence
      summary: Ask intelligence question
      description: 'Ask a question using Intelligence Q&A with Knowledge Base RAG.


        This endpoint provides programmatic access to AnomalyArmor''s intelligence

        Q&A system. It uses the generated markdown knowledge base as context

        for accurate and comprehensive answers.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client


        client = Client()

        answer = client.intelligence.ask(

        asset="postgresql.analytics",

        question="list upstream tables for schema.table_name"

        )

        print(answer.answer)

        ```


        **CLI Usage:**

        ```bash

        aa intelligence ask postgresql.analytics "list upstream tables for schema.table_name"

        ```'
      operationId: intelligence_ask_api_v1_sdk_intelligence_ask_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntelligenceAskRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/sdk/intelligence/generate:
    post:
      tags:
      - public-intelligence
      summary: Generate intelligence for an asset
      description: 'Trigger intelligence generation for an asset.


        This endpoint triggers AI analysis of the asset''s schema to generate

        descriptions, summaries, and a knowledge base for Q&A.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client


        client = Client()

        result = client.intelligence.generate(asset="postgresql.analytics")

        print(f"Job ID: {result.job_id}")

        ```


        **CLI Usage:**

        ```bash

        armor intelligence generate postgresql.analytics

        ```'
      operationId: intelligence_generate_api_v1_sdk_intelligence_generate_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntelligenceGenerateRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/sdk/intelligence/{asset_id}/knowledge-base:
    get:
      tags:
      - public-intelligence
      summary: Get Asset Knowledge Base
      description: 'Load knowledge base context for an asset.


        Returns the full markdown KB content for LLM system prompt enrichment.

        MCP clients call this once per session to load asset intelligence.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client

        client = Client()

        kb = client.intelligence.knowledge_base("asset-uuid")

        if kb.available:

        print(kb.markdown) # Full asset KB for LLM context

        ```'
      operationId: get_asset_knowledge_base_api_v1_sdk_intelligence__asset_id__knowledge_base_get
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    IntelligenceGenerateRequest:
      properties:
        asset_id:
          type: string
          title: Asset Id
          description: Asset identifier (public UUID, short UUID, or asset name)
        include_schemas:
          anyOf:
          - type: string
          - type: 'null'
          title: Include Schemas
          description: 'Comma-separated list of schemas to analyze (default: all)'
        include_tables:
          anyOf:
          - type: string
          - type: 'null'
          title: Include Tables
          description: Comma-separated list of specific tables to analyze (e.g., 'schema.table1,schema.table2')
        force_refresh:
          type: boolean
          title: Force Refresh
          description: Force regeneration even if intelligence exists
          default: false
      type: object
      required:
      - asset_id
      title: IntelligenceGenerateRequest
      description: Request to generate intelligence for an asset.
    IntelligenceAskRequest:
      properties:
        asset_id:
          type: string
          title: Asset Id
          description: Asset identifier (public UUID or qualified name like 'postgresql.mydb')
        question:
          type: string
          maxLength: 2000
          minLength: 3
          title: Question
          description: Natural language question to ask
        include_related_assets:
          type: boolean
          title: Include Related Assets
          description: Include related assets in context
          default: false
      type: object
      required:
      - asset_id
      - question
      title: IntelligenceAskRequest
      description: Request to ask an intelligence question.
    StandardResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - {}
          - type: 'null'
          title: Data
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: StandardResponse
      description: Standard API response wrapper.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json