makespdf-com Validate API

openapi: 3.2.0
info:
  title: makesPDF Validate API
  version: 1.0.0
  description: 'Deterministic PDF rendering API: GitHub-flavoured Markdown or a compact DSL to tagged, PDF/A-2A + PDF/UA-1 dual-compliant PDFs. Authenticate with a Bearer token (API key or OAuth device flow), or pay per call via x402 (USDC on Base) on the x402-tagged operations. Errors use the shared Error schema. Rate limits are reported in RateLimit / RateLimit-Policy headers, with Retry-After on 429. Versioning: the major version is in the path (/api/v1); breaking changes ship as a new version, and a deprecated endpoint keeps working for at least 90 days after it starts sending Deprecation and Sunset headers.'
  x-guidance: 'POST /api/v1/markdown converts markdown to PDF ($0.01). POST /api/v1/render renders a template from templateId or inline DSL ($0.02). Both require an x402 payment: call unpaid to receive the 402 challenge (PAYMENT-REQUIRED header), sign an EIP-3009 USDC transfer, retry with the PAYMENT-SIGNATURE header. Free: GET /api/v1/templates?owner=library lists curated templates.'
  contact:
    name: makesPDF support
    email: jason@makespdf.com
    url: https://makespdf.com/contact
servers:
- url: https://makespdf.com
security: []
tags:
- name: Validate
paths:
  /api/v1/md/validate:
    summary: Validate markdown
    description: Check markdown for PDF/UA-1 accessibility issues (heading hierarchy, missing alt text) without rendering.
    post:
      operationId: validateMarkdown
      summary: Validate markdown accessibility
      description: Reports heading-hierarchy and missing-alt-text issues without rendering. Not billed.
      tags:
      - Validate
      responses:
        '200':
          description: Validation result.
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - markdown
              properties:
                markdown:
                  type: string
  /api/v1/preview/validate:
    summary: Validate DSL template
    description: Check a DSL template for structure and accessibility issues without rendering.
    post:
      operationId: validateTemplate
      summary: Validate a DSL template
      description: Runs catalog validation (tags, nesting, styles) and alt-text checks without rendering. Not billed.
      tags:
      - Validate
      responses:
        '200':
          description: Validation result.
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - dsl
              properties:
                dsl:
                  type: string
components:
  schemas:
    Error:
      type: object
      required:
      - error
      description: Every 4xx/5xx JSON body. `error` is always present; the other fields appear when they apply.
      properties:
        error:
          type: string
          description: Human-readable message. Some routes use a stable kebab-case value (e.g. `rate-limited`, `in-place-impossible`) that is safe to branch on.
        code:
          type: string
          description: Machine-readable error code, when the route sets one (e.g. `containers-disabled`).
        details:
          type: array
          items:
            type: string
          description: 'Per-field validation messages, `path: message`.'
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          description: Template validation issues, on DSL/catalog failures.
        hint:
          type: string
          description: How to fix the request.
        retryAfter:
          type: integer
          description: Seconds until the rate limit resets (429 only; mirrors Retry-After).
        docs:
          type: string
          format: uri
        agent_guide:
          type: string
          format: uri
        skill:
          type: string
          format: uri
      additionalProperties: true
    ValidationResult:
      type: object
      required:
      - valid
      - issues
      - summary
      properties:
        valid:
          type: boolean
          description: True when there are no error-severity issues.
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
        summary:
          type: object
          required:
          - errors
          - warnings
          properties:
            errors:
              type: integer
            warnings:
              type: integer
    ValidationIssue:
      type: object
      required:
      - severity
      - message
      properties:
        severity:
          type: string
          enum:
          - error
          - warning
        message:
          type: string
        path:
          type: string
          description: Location in the document tree.
        rule:
          type: string
          description: Rule identifier, e.g. a PDF/UA check.
  headers:
    RateLimit:
      description: Quota left in each policy this request counted against (draft-ietf-httpapi-ratelimit-headers-11), e.g. `"render";r=1999;t=3600`. `r` = requests remaining, `t` = seconds until the oldest counted request leaves the window.
      schema:
        type: string
    RateLimit-Policy:
      description: Policies this request counted against, e.g. `"render";q=2000;w=3600`. `q` = quota, `w` = window in seconds.
      schema:
        type: string
    Retry-After:
      description: Seconds to wait before retrying. Takes precedence over RateLimit.
      schema:
        type: integer
        minimum: 0
  responses:
    Unauthorized:
      description: Missing or invalid Bearer token. The body links the docs, llms.txt and the auth skill.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected server error. Never billed.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limit exceeded.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Malformed body or failed validation. Never billed.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key or OAuth device-flow token sent as `Authorization: Bearer <token>`. Agents should get one through the device flow (/skills/pdf-auth.md); never ask a user for their password.'
externalDocs:
  description: API reference, including errors, rate limits and the versioning policy
  url: https://makespdf.com/docs/api
x-discovery:
  ownershipProofs:
  - '0xF4d2bC1034beE5eA270AcA773aEB97736d14fb31'