agentseo-dev Analyze API

openapi: 3.2.0
info:
  title: AgentSEO Analyze 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: Analyze
paths:
  /analyze/serp:
    post:
      summary: Analyze SERP
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyzeSerpParams'
      responses:
        '200':
          description: Completed SERP analysis primitive with serp_opportunity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyzeSerpResponse'
        '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:
      - Analyze
      operationId: postAnalyzeSerp
      x-operation-id-source: derived
components:
  schemas:
    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
    AnalyzeSerpParams:
      type: object
      required:
      - keyword
      properties:
        keyword:
          type: string
        location:
          type: string
          default: United States
        location_code:
          type: integer
          minimum: 1
          description: Optional search location code for deterministic geo-targeting.
        device:
          type: string
          enum:
          - desktop
          - mobile
          default: desktop
        language:
          type: string
          default: en
    JobContext:
      type: object
      properties:
        project_id:
          type: string
          nullable: true
        workflow_id:
          type: string
          nullable: true
    SerpOpportunity:
      type: object
      properties:
        summary:
          type: string
        likely_intent:
          type: string
          enum:
          - informational
          - commercial_investigation
          - transactional
          - local
        competition_level:
          type: string
          enum:
          - high
          - medium
          - low
        dominant_features:
          type: array
          items:
            type: string
        recommended_content_format:
          type: string
          enum:
          - answer_page
          - comparison_page
          - guide
          - local_landing_page
          - service_page
        top_domains:
          type: array
          items:
            type: string
        recommended_next_calls:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowNextCall'
        confidence:
          type: number
          minimum: 0
          maximum: 1
    AnalyzeSerpResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            additionalProperties: true
        search_parameters:
          type: object
          additionalProperties: true
        serp_features:
          type: array
          items:
            type: object
            additionalProperties: true
        keyword_metrics:
          type: object
          nullable: true
          additionalProperties: true
        serp_opportunity:
          $ref: '#/components/schemas/SerpOpportunity'
        markdown_summary:
          type: string
    AgentWorkflowNextCall:
      type: object
      properties:
        endpoint:
          type: string
        reason:
          type: string
    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