agentseo-dev Audit API

openapi: 3.2.0
info:
  title: AgentSEO Audit API
  version: 0.1.0
  description: API for agent-ready SEO data extraction, analysis, and async job processing.
servers:
- url: https://www.agentseo.dev/api/v1
  description: Production
- url: http://localhost:3000/api/v1
  description: Local
security:
- ApiKeyAuth: []
tags:
- name: Audit
paths:
  /audit/local:
    post:
      summary: Local listing audit (AEO starter)
      description: Audits one business listing using its name and location. Domains, website URLs, and page URLs are not business names and are rejected before charging. The legacy domain field accepts business-name text only during migration.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocalAuditParams'
      responses:
        '400':
          description: Invalid or unsupported business-name input; no job or debit created
        '200':
          description: Completed local audit with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalAuditResponse'
        '202':
          description: Job queued or still processing
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/QueuedJobResponse'
                - $ref: '#/components/schemas/SyncPendingResponse'
                - $ref: '#/components/schemas/JobStatusEnvelope'
      tags:
      - Audit
      operationId: postAuditLocal
      x-operation-id-source: derived
  /audit/local/batch:
    post:
      summary: Batch local audit
      description: Each item requires a business name and location. The entire batch is validated before any job or debit is created.
      parameters:
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - items
              properties:
                items:
                  type: array
                  maxItems: 10
                  items:
                    $ref: '#/components/schemas/LocalAuditParams'
      responses:
        '400':
          description: Invalid item; no jobs or debits created
        '202':
          description: Jobs queued
      tags:
      - Audit
      operationId: postAuditLocalBatch
      x-operation-id-source: derived
components:
  schemas:
    LocalAuditParams:
      type: object
      required:
      - business_name
      - location
      properties:
        business_name:
          type: string
          description: Business name as shown on Google Maps. Website domains and URLs are not accepted. Legacy clients may pass a business name in domain during the compatibility window.
        location:
          type: string
          description: City, state, and country to geo-target the listing lookup.
        language:
          type: string
          default: en
    AgentWorkflowAction:
      type: object
      properties:
        priority:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
        action:
          type: string
        why:
          type: string
    JobStatusEnvelope:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - queued
          - processing
          - retrying
          - completed
          - failed
        phase:
          type: string
          enum:
          - queued
          - submitting_analysis
          - waiting_analysis
          - transforming
          - finalizing
        progress:
          type: object
          properties:
            percent:
              type: number
            indeterminate:
              type: boolean
            eta_seconds:
              type: integer
              nullable: true
        attempt:
          type: integer
        max_attempts:
          type: integer
        message:
          type: string
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
        result:
          nullable: true
        error:
          type: object
          nullable: true
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
        context:
          allOf:
          - $ref: '#/components/schemas/JobContext'
          nullable: true
        poll_url:
          type: string
        events_url:
          type: string
        retry_after_seconds:
          type: integer
    QueuedJobResponse:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - queued
          - processing
          - retrying
          - completed
          - failed
        message:
          type: string
        poll_url:
          type: string
        events_url:
          type: string
        retry_after_seconds:
          type: integer
    JobContext:
      type: object
      properties:
        project_id:
          type: string
          nullable: true
        workflow_id:
          type: string
          nullable: true
    LocalAuditResponse:
      type: object
      properties:
        business_name:
          type: string
        rating:
          type: number
        review_count:
          type: integer
        address:
          type: string
        knowledge_graph:
          type: object
          additionalProperties: true
        aeo_audit:
          type: object
          additionalProperties: true
        agent_brief:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    AgentWorkflowEvidence:
      type: object
      properties:
        finding:
          type: string
        detail:
          type: string
        severity:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
    AgentWorkflowNextCall:
      type: object
      properties:
        endpoint:
          type: string
        reason:
          type: string
    AgentWorkflow:
      type: object
      properties:
        summary:
          type: string
        decision:
          type: string
          enum:
          - ready
          - act_now
          - monitor
          - blocker
        confidence:
          type: number
          minimum: 0
          maximum: 1
        recommended_actions:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowAction'
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowEvidence'
        limitations:
          type: array
          items:
            type: string
        next_calls:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowNextCall'
    SyncPendingResponse:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - pending
          - processing
        poll_url:
          type: string
        events_url:
          type: string
        retry_after_seconds:
          type: integer
  parameters:
    SyncParam:
      name: sync
      in: query
      required: false
      schema:
        type: boolean
        default: false
      description: Open a short inline processing window when supported by the endpoint. If the result is not ready yet, the endpoint may still return 202 with a queued payload that includes poll_url, events_url, and retry_after_seconds.
    WorkflowIdHeader:
      name: x-workflow-id
      in: header
      required: false
      schema:
        type: string
        maxLength: 120
      description: Optional attribution label for grouping usage and jobs by workflow or agent run.
    ProjectIdHeader:
      name: x-project-id
      in: header
      required: false
      schema:
        type: string
        maxLength: 120
      description: Optional attribution label for grouping usage and jobs by project.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key