agentseo-dev Site API

The Site API from agentseo-dev — 1 operation(s) for site.

Operations 1

POST /site/sitemap-audit Sitemap and orphan-page audit #

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-site-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.

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

OpenAPI Specification

agentseo-dev-site-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AgentSEO Site 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: Site
paths:
  /site/sitemap-audit:
    post:
      summary: Sitemap and orphan-page audit
      description: Audit sitemap coverage, sitemap-only orphan candidates, important URLs, canonical/indexability noise, and internal-link gaps. Costs 2 credits and does not call a paid search API.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteSitemapAuditParams'
      responses:
        '200':
          description: Completed sitemap audit workflow with findings and agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteSitemapAuditResponse'
        '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:
      - Site
      operationId: postSiteSitemapAudit
      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
    SiteSitemapAuditParams:
      type: object
      description: Provide sitemap_url or sitemap_xml. Optional crawl and internal-link exports improve orphan-page detection.
      properties:
        target:
          type: string
          description: Optional target brand, domain, or product.
        sitemap_url:
          type: string
          format: uri
          description: Sitemap URL to fetch.
        sitemap_xml:
          type: string
          minLength: 80
          maxLength: 2000000
          description: Raw sitemap XML.
        max_sitemap_children:
          type: integer
          minimum: 0
          maximum: 10
          default: 3
        important_urls:
          type: array
          maxItems: 500
          items:
            type: string
            format: uri
          default: []
        crawl_urls:
          type: array
          maxItems: 5000
          items:
            type: object
            required:
            - url
            properties:
              url:
                type: string
                format: uri
              source:
                type: string
                maxLength: 80
              title:
                type: string
                maxLength: 180
              status_code:
                type: integer
                minimum: 100
                maximum: 599
              indexable:
                type: boolean
                default: true
              canonical_url:
                type: string
                format: uri
              inbound_internal_links:
                type: integer
                minimum: 0
              clicks:
                type: number
                minimum: 0
              impressions:
                type: number
                minimum: 0
          default: []
        internal_links:
          type: array
          maxItems: 20000
          items:
            type: object
            required:
            - source_url
            - target_url
            properties:
              source_url:
                type: string
                format: uri
              target_url:
                type: string
                format: uri
              anchor:
                type: string
                maxLength: 160
          default: []
    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
    SiteSitemapAuditResponse:
      type: object
      properties:
        target:
          type: string
          nullable: true
        sitemap_audit:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    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'
    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