agentseo-dev

agentseo-dev Ai Overview API

The Ai Overview API from agentseo-dev — 1 operation(s) for ai overview.

GitHub OpenAPI

Operations 1

POST /ai-overview/extract AI overview extraction #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/agentseo-dev/openapi/agentseo-dev-ai-overview-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-programmatic-template-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-content-action-plan-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-page-intersection-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-ai-visibility-prompt-set-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-backlinks-opportunity-finder-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-backlinks-page-intersection-params-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/agentseo-dev/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/agentseo-dev:agentseo-dev-ai-overview-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

agentseo-dev-ai-overview-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AgentSEO Ai Overview 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: Ai Overview
paths:
  /ai-overview/extract:
    post:
      summary: AI overview extraction
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AiOverviewParams'
      responses:
        '200':
          description: Completed AI overview workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiOverviewResponse'
        '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:
      - Ai Overview
      operationId: postAiOverviewExtract
      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
    GeoTarget:
      type: object
      properties:
        input:
          type: string
          nullable: true
        location_code:
          type: integer
        location_name:
          type: string
          nullable: true
        country_iso_code:
          type: string
          nullable: true
        source:
          type: string
          enum:
          - resolved
          - explicit_code
    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
    AgentWorkflowNextCall:
      type: object
      properties:
        endpoint:
          type: string
        reason:
          type: string
    AiOverviewResponse:
      type: object
      properties:
        keyword:
          type: string
        location:
          type: string
        target_domain:
          type: string
          nullable: true
        geo_target:
          $ref: '#/components/schemas/GeoTarget'
        ai_overview_detected:
          type: boolean
        overview_status:
          type: string
          enum:
          - detected
          - not_detected
        citations:
          type: array
          items:
            type: object
            properties:
              rank:
                type: integer
              title:
                type: string
              url:
                type: string
                format: uri
        overview_audit:
          type: object
          properties:
            overview_summary:
              type: string
              nullable: true
            citation_domains:
              type: array
              items:
                type: string
            citation_analysis:
              type: object
              properties:
                scope:
                  type: string
                  enum:
                  - sampled_serp_candidates
                target_domain:
                  type: string
                  nullable: true
                target_domain_present:
                  type: boolean
                  nullable: true
                target_domain_rank:
                  type: integer
                  nullable: true
                competing_domains:
                  type: array
                  items:
                    type: string
            content_requirements:
              type: array
              items:
                type: string
            recommended_asset_type:
              type: string
              enum:
              - answer_page
              - comparison_page
              - local_landing_page
              - guide
            opportunity_level:
              type: string
              enum:
              - high
              - medium
              - low
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    JobContext:
      type: object
      properties:
        project_id:
          type: string
          nullable: true
        workflow_id:
          type: string
          nullable: true
    AgentWorkflowEvidence:
      type: object
      properties:
        finding:
          type: string
        detail:
          type: string
        severity:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
    AiOverviewParams:
      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.
        language:
          type: string
          default: en
        target_domain:
          type: string
          description: Optional domain to check against the sampled citation candidates.
    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