AgentReady.me Scans API

Evidence-backed agent-readiness analysis for public URLs.

Operations 3

POST /api/v1/scan Scan a public URL for AI-agent readiness #
POST /api/scan Compatibility alias for the v1 public scan #
GET /api/v1/report Retrieve the latest or historical public scan report #

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/agentready-me:agentready-me-scans-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

agentready-me-scans-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Agentready Me Scans API
  version: 1.4.0
  description: 'Operations tagged Scans across 2 of this provider''s published API definitions: agentready-me-openapi.json, agentready-me.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.agentready.me
tags:
- name: Scans
  description: Evidence-backed agent-readiness analysis for public URLs.
paths:
  /api/v1/scan:
    post:
      operationId: scanPublicUrl
      tags:
      - Scans
      summary: Scan a public URL for AI-agent readiness
      description: Normalizes and validates a public HTTP URL, runs the Tier 1 readiness scan, and returns scores, evidence, recommendations, and a Fix Pack v2 execution contract. Enhanced scans require a signed-in user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicScanRequest'
            examples:
              standard:
                value:
                  url: example.com
                  includePlaywright: true
      responses:
        '200':
          description: Readiness score, phase findings, prioritized recommendations, and Fix Pack.
          headers:
            RateLimit-Limit:
              description: Maximum anonymous scans in the active window.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Anonymous scans remaining in the active window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the active window resets.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanResult'
        '400':
          description: The request is missing a URL or the target is not a valid public HTTP URL.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: The requested enhanced scan requires a signed-in account.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: The anonymous public-scan limit has been reached.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
            RateLimit-Limit:
              description: Maximum anonymous scans in the active window.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Anonymous scans remaining in the active window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the active window resets.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: The scan could not be completed.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://www.agentready.me
  /api/scan:
    post:
      operationId: scanPublicUrlCompatibilityAlias
      tags:
      - Scans
      summary: Compatibility alias for the v1 public scan
      description: 'Backward-compatible alias of POST /api/v1/scan. It returns X-API-Version: 1 and a successor-version Link header. New integrations should use the versioned path.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicScanRequest'
      responses:
        '200':
          description: Same typed response as /api/v1/scan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanResult'
        '400':
          description: Invalid request.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Enhanced scan authentication required.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Anonymous scan limit reached.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Scan failed.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://www.agentready.me
  /api/v1/report:
    get:
      operationId: getPublicReport
      tags:
      - Scans
      summary: Retrieve the latest or historical public scan report
      description: Returns an explicitly published, unlisted report by opaque id. Set history=true to receive up to 12 snapshots newest first. Links expire after 30 days.
      parameters:
      - name: id
        in: query
        required: true
        description: Opaque report id returned after a scan with publishReport=true.
        schema:
          type: string
          minLength: 8
          maxLength: 128
      - name: history
        in: query
        required: false
        description: Return the complete saved history.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Latest public report or report history.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicReportResponse'
        '400':
          description: Invalid or missing opaque report id.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails_2'
        '404':
          description: No active public report exists for this id.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails_2'
        '503':
          description: Public report storage is unavailable.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails_2'
    servers:
    - url: https://www.agentready.me
components:
  schemas:
    PublicScanRequest:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    ScanResult:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    ProblemDetails:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    ReadinessPreview:
      type: object
      required:
      - model
      - methodologyVersion
      - score
      - coverage
      - checks
      - legacyScore
      properties:
        model:
          type: string
          const: applicability-aware-v2
        methodologyVersion:
          type: string
        score:
          type: number
          minimum: 0
          maximum: 100
        coverage:
          type: number
          minimum: 0
          maximum: 100
        checks:
          type: array
          items:
            $ref: '#/components/schemas/ReadinessCheck'
        legacyScore:
          type: number
          minimum: 0
          maximum: 100
        note:
          type: string
      additionalProperties: true
    ScanPhase:
      type: object
      required:
      - phaseName
      - score
      - maxScore
      - findings
      - recommendations
      properties:
        phaseName:
          type: string
        score:
          type: number
        maxScore:
          type: number
        findings:
          type: array
          items:
            $ref: '#/components/schemas/Finding'
        recommendations:
          type: array
          items:
            $ref: '#/components/schemas/Recommendation'
    FixItem:
      type: object
      required:
      - id
      - phase
      - severity
      - title
      - why
      - fix
      - evidence
      - applicability
      - humanReviewRequired
      - acceptance
      - acceptanceAssertions
      - liveAssertions
      properties:
        id:
          type: string
        checkId:
          type: string
          description: Stable scanner-owned check identifier when available.
        phase:
          type: string
        severity:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
        title:
          type: string
        why:
          type: string
        fix:
          type: string
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/FixEvidence'
        applicability:
          type: string
          enum:
          - required
          - conditional
          - not_applicable
        dependencies:
          type: array
          items:
            type: string
        implementation:
          type: object
          additionalProperties: true
        humanReviewRequired:
          type: boolean
        reviewReasons:
          type: array
          items:
            type: string
        acceptance:
          type: string
        acceptanceAssertions:
          type: array
          items:
            type: object
            additionalProperties: true
        liveAssertions:
          type: array
          items:
            type: string
        scoreImpact:
          type: number
    FixPack:
      type: object
      required:
      - version
      - scannerVersion
      - methodologyVersion
      - url
      - scannedAt
      - score
      - maxScore
      - targetResolution
      - fixes
      - verify
      properties:
        version:
          type: integer
          const: 2
        scannerVersion:
          type: string
        methodologyVersion:
          type: string
          const: 2026-08-23-v2
        url:
          type: string
          format: uri
        scannedAt:
          type: string
          format: date-time
        score:
          type: number
        maxScore:
          type: number
        targetResolution:
          type: string
          const: candidate_until_repository_connected
        fixes:
          type: array
          items:
            $ref: '#/components/schemas/FixItem'
        verify:
          type: object
          additionalProperties: true
    CapabilityResult:
      type: object
      required:
      - state
      - scored
      - evidence
      properties:
        state:
          type: string
          enum:
          - observed
          - advertised
          - suspected
          - absent
        scored:
          type: boolean
        evidence:
          type: array
          items:
            type: string
    PublicReportSnapshotPayload:
      allOf:
      - $ref: '#/components/schemas/ScanResult_2'
      - type: object
        required:
        - snapshot
        - publicReportUrl
        properties:
          id:
            type: string
          publicReportUrl:
            type: string
            format: uri
          snapshot:
            $ref: '#/components/schemas/PublicReportSnapshot'
    PublicReportHistoryResponse:
      type: object
      required:
      - url
      - latest
      - history
      - snapshots
      - report
      properties:
        url:
          type: string
          format: uri
        latest:
          $ref: '#/components/schemas/PublicReportSnapshotPayload'
        history:
          type: array
          maxItems: 12
          items:
            $ref: '#/components/schemas/PublicReportSnapshotPayload'
        snapshots:
          type: array
          maxItems: 12
          items:
            $ref: '#/components/schemas/PublicReportSnapshotPayload'
        report:
          $ref: '#/components/schemas/PublicReportSummary'
    FixEvidence:
      type: object
      required:
      - source
      - observedAt
      - message
      properties:
        source:
          type: string
          enum:
          - live_scan
          - repository_scan
          - user_input
        observedAt:
          type: string
          format: date-time
        message:
          type: string
        url:
          type: string
          format: uri
        details:
          type: string
    Recommendation:
      type: object
      required:
      - priority
      - title
      - description
      - actionable
      properties:
        key:
          type: string
        priority:
          type: string
          enum:
          - high
          - medium
          - low
        title:
          type: string
        description:
          type: string
        actionable:
          type: string
        scoreImpact:
          type: number
    PublicReportResponse:
      oneOf:
      - $ref: '#/components/schemas/PublicReportSnapshotPayload'
      - $ref: '#/components/schemas/PublicReportHistoryResponse'
    PublicReportSnapshot:
      type: object
      required:
      - id
      - url
      - score
      - maxScore
      - scannedAt
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
        score:
          type: number
          minimum: 0
          maximum: 100
        maxScore:
          type: number
        scannedAt:
          type: string
          format: date-time
        result:
          $ref: '#/components/schemas/ScanResult_2'
    ScanResult_2:
      type: object
      required:
      - url
      - score
      - maxScore
      - phases
      - scannedAt
      properties:
        url:
          type: string
          format: uri
        score:
          type: number
          minimum: 0
          maximum: 100
        maxScore:
          type: number
          const: 100
        scannedAt:
          type: string
          format: date-time
        executiveSummary:
          type: string
        topPriorities:
          type: array
          items:
            type: string
        phases:
          type: array
          items:
            $ref: '#/components/schemas/ScanPhase'
        metadata:
          type: object
          properties:
            fixPack:
              $ref: '#/components/schemas/FixPack'
            readiness:
              $ref: '#/components/schemas/ReadinessPreview'
            capabilities:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/CapabilityResult'
          additionalProperties: true
    ReadinessCheck:
      type: object
      required:
      - id
      - title
      - tier
      - surface
      - status
      - weight
      - evidence
      properties:
        id:
          type: string
        title:
          type: string
        tier:
          type: string
          enum:
          - essential
          - recommended
          - bonus
        surface:
          type: string
          enum:
          - web
          - api
          - auth
          - mcp
          - commerce
          - repository
        status:
          type: string
          enum:
          - pass
          - partial
          - fail
          - not_applicable
          - unobservable
        weight:
          type: number
        credit:
          type: number
          minimum: 0
          maximum: 1
        applicabilityReason:
          type: string
        evidence:
          type: array
          items: {}
    ProblemDetails_2:
      type: object
      description: RFC 9457 Problem Details with stable AgentReady extensions.
      required:
      - type
      - title
      - status
      - detail
      - code
      - error
      properties:
        type:
          type: string
          format: uri
          description: Stable machine-readable problem type.
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        code:
          type: string
          description: Stable AgentReady error code.
        error:
          type: string
          description: Backward-compatible alias of detail.
    Finding:
      type: object
      required:
      - type
      - message
      properties:
        type:
          type: string
          enum:
          - success
          - warning
          - error
        message:
          type: string
        details:
          type: string
    PublicScanRequest_2:
      type: object
      additionalProperties: false
      required:
      - url
      properties:
        url:
          type: string
          description: Public hostname or HTTP(S) URL.
          examples:
          - example.com
        includePlaywright:
          type: boolean
          default: true
          description: Run browser-backed checks when available.
        enhanced:
          type: boolean
          default: false
          description: Run signed-in enhanced agent tasks.
        publishReport:
          type: boolean
          default: false
          description: Explicitly create an unlisted report link that expires after 30 days.
    PublicReportSummary:
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
x-refined-from:
- agentready-me-openapi.json
- agentready-me.json