agentseo-dev Pages API

openapi: 3.2.0
info:
  title: AgentSEO Pages 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: Pages
paths:
  /pages/intersection:
    post:
      summary: Page intersection
      description: Compare ranking pages to find shared page keywords or competitor-page keywords excluded from your pages. Costs 5 credits per 100 requested keywords, minimum 5. Clickstream enrichment doubles credit cost.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageIntersectionParams'
      responses:
        '200':
          description: Completed page intersection workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageIntersectionResponse'
        '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:
      - Pages
      operationId: postPagesIntersection
      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
    AgentWorkflowAction:
      type: object
      properties:
        priority:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
        action:
          type: string
        why:
          type: string
    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
    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
    JobContext:
      type: object
      properties:
        project_id:
          type: string
          nullable: true
        workflow_id:
          type: string
          nullable: true
    PageIntersectionParams:
      type: object
      required:
      - pages
      properties:
        pages:
          type: array
          minItems: 1
          maxItems: 5
          items:
            type: string
            format: uri
          description: Absolute page URLs or wildcard URL patterns to compare.
        exclude_pages:
          type: array
          maxItems: 5
          items:
            type: string
            format: uri
          default: []
          description: Absolute page URLs or wildcard URL patterns to exclude, usually your own page group.
        location:
          type: string
          default: United States
          description: Human-friendly search market. If provided with location_code, location_code wins.
        location_code:
          type: integer
          minimum: 1
          description: Optional provider location code for deterministic geo-targeting.
        language:
          type: string
          default: en
        item_types:
          type: array
          minItems: 1
          maxItems: 4
          items:
            type: string
            enum:
            - organic
            - paid
            - featured_snippet
            - local_pack
          default:
          - organic
          - featured_snippet
        limit:
          type: integer
          minimum: 5
          maximum: 100
          default: 25
        offset:
          type: integer
          minimum: 0
          maximum: 20000
          default: 0
        include_subdomains:
          type: boolean
          default: true
        intersection_mode:
          type: string
          enum:
          - union
          - intersect
          default: union
        include_serp_info:
          type: boolean
          default: false
        include_clickstream_data:
          type: boolean
          default: false
          description: Doubles credit cost when true.
        ignore_synonyms:
          type: boolean
          default: true
        min_search_volume:
          type: integer
          minimum: 0
          maximum: 10000000
          default: 0
        max_rank:
          type: integer
          minimum: 1
          maximum: 100
          default: 30
        sort_by:
          type: string
          enum:
          - opportunity
          - search_volume
          - traffic_gap
          - rank
          - cpc
          default: opportunity
    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'
    PageIntersectionResponse:
      type: object
      properties:
        pages:
          type: array
          items:
            type: string
        exclude_pages:
          type: array
          items:
            type: string
        location:
          type: object
          additionalProperties: true
        page_intersection:
          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
  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