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/pdfs-build:pdfs-build-render-logs-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

openapi: 3.2.0
info:
  title: pdfs.build Render logs API
  version: '2.0'
  summary: Render PDFs from templates, manage templates, webhooks, embedded editor sessions and delegated agent access.
  description: 'All requests are authenticated with an organization-scoped API key (`prs_...`) sent as a Bearer token. Create keys under **Settings → API Keys** in the dashboard or with the MCP `create_api_key` tool. Keys are shown once.


    The organization in every `/v2` URL must match the key''s organization, otherwise the request fails with `403 organization_scope_mismatch`.


    **Errors** are JSON with a top-level `error` string — a machine-readable code for most failures, a phrase for a few legacy ones — usually alongside a human-readable `message`. Data validation and template compilation failures carry `details` / `diagnostics` instead of a `message`.


    **Versions.** `/v2` addresses templates by an external id you control. The legacy `/v1` routes identify templates by their generated internal id and remain supported for existing integrations.


    **Timestamps.** Objects served by the render service (templates, render jobs, logs, webhook endpoints) carry UTC timestamps in ISO 8601 form without a timezone suffix, e.g. `2026-08-30T12:00:00.123456`. Embedded-editor sessions and delegated access return RFC 3339 with a trailing `Z`.


    The narrative guide — authentication, webhook signatures, the MCP server, migrating from v1 — lives at https://pdfs.build/docs/ (Markdown mirror: https://pdfs.build/docs.md).'
  contact:
    name: pdfs.build
    url: https://pdfs.build
    email: hello@pdfs.build
  termsOfService: https://pdfs.build/terms/
  license:
    name: Proprietary
    url: https://pdfs.build/terms/
servers:
- url: https://api.pdfs.build
  description: Production
security:
- apiKey: []
tags:
- name: Render logs
  description: Audit trail of every render — API, app, and MCP.
paths:
  /v2/organizations/{organizationId}/templates/{externalId}/logs:
    parameters:
    - $ref: '#/components/parameters/organizationId'
    - $ref: '#/components/parameters/externalId'
    get:
      tags:
      - Render logs
      summary: List render logs for a template
      operationId: listTemplateLogs
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/logStatus'
      - $ref: '#/components/parameters/logSource'
      responses:
        '200':
          description: Newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderLogList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/OrganizationScopeMismatch'
        '404':
          $ref: '#/components/responses/TemplateNotFound'
  /v2/organizations/{organizationId}/logs:
    parameters:
    - $ref: '#/components/parameters/organizationId'
    get:
      tags:
      - Render logs
      summary: List render logs
      operationId: listLogs
      description: Paginated render events for the organization. Each log carries `templateInternalId` and the `templateExternalId` captured when the render happened, so later renames do not rewrite history — filter by the historical alias with `externalId`.
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/logStatus'
      - $ref: '#/components/parameters/logSource'
      - name: externalId
        in: query
        schema:
          type: string
        description: Only logs whose template external id was this value at render time.
      - name: search
        in: query
        schema:
          type: string
        description: Free-text match on template name.
      - name: from
        in: query
        schema:
          type: string
          format: date-time
        description: Only logs created at or after this instant (ISO 8601).
      - name: to
        in: query
        schema:
          type: string
          format: date-time
        description: Only logs created before this instant (ISO 8601).
      responses:
        '200':
          description: Newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderLogList'
        '400':
          $ref: '#/components/responses/InvalidExternalId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/OrganizationScopeMismatch'
  /v2/organizations/{organizationId}/logs/{logId}:
    parameters:
    - $ref: '#/components/parameters/organizationId'
    - $ref: '#/components/parameters/logId'
    get:
      tags:
      - Render logs
      summary: Get render log
      operationId: getLog
      description: One render event, including the `requestPayload` that was rendered.
      responses:
        '200':
          description: The log entry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderLogDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/OrganizationScopeMismatch'
        '404':
          description: Unknown log id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Log not found
components:
  schemas:
    Timestamp:
      type: string
      description: UTC, ISO 8601 without a timezone suffix.
      example: '2026-08-30T12:00:00.123456'
    RenderLogList:
      type: object
      required:
      - logs
      - total
      properties:
        logs:
          type: array
          items:
            $ref: '#/components/schemas/RenderLog'
        total:
          type: integer
          description: Total matching logs, for pagination.
    ExternalId:
      type: string
      pattern: ^[A-Za-z0-9._~-]{1,128}$
      description: Organization-scoped template id you control. 1–128 ASCII letters, digits, `.`, `_`, `~` or `-`; `.` and `..` are reserved. Case-sensitive.
    RenderLog:
      type: object
      required:
      - id
      - templateInternalId
      - templateExternalId
      - source
      - status
      - createdAt
      - apiKeyName
      - apiKeyPrefix
      properties:
        id:
          type: string
        templateInternalId:
          type: string
        templateExternalId:
          type:
          - string
          - 'null'
          description: The external id at render time; renames do not rewrite it.
        templateName:
          type:
          - string
          - 'null'
        source:
          type: string
          description: '`api`, `ui`, `mcp`, or another in-app source.'
        status:
          type: string
          enum:
          - pending
          - success
          - error
        errorMessage:
          type:
          - string
          - 'null'
        durationMs:
          type:
          - integer
          - 'null'
        apiKeyId:
          type:
          - string
          - 'null'
        userId:
          type:
          - string
          - 'null'
        templateUpdatedAt:
          oneOf:
          - $ref: '#/components/schemas/Timestamp'
          - type: 'null'
        createdAt:
          $ref: '#/components/schemas/Timestamp'
        apiKeyName:
          type:
          - string
          - 'null'
        apiKeyPrefix:
          type:
          - string
          - 'null'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Machine-readable code (e.g. `draft_not_renderable`) or, for a few legacy failures, a short phrase.
        message:
          type: string
          description: Human-readable detail. Present on most coded errors.
      example:
        error: draft_not_renderable
        message: Only published templates can be rendered via the API. Publish this template first.
    RenderLogDetail:
      allOf:
      - $ref: '#/components/schemas/RenderLog'
      - type: object
        required:
        - organizationId
        properties:
          organizationId:
            type: string
          requestPayload:
            type:
            - object
            - 'null'
            description: The `data` that was rendered.
            additionalProperties: true
  parameters:
    logStatus:
      name: status
      in: query
      schema:
        type: string
        enum:
        - success
        - error
    offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
    externalId:
      name: externalId
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/ExternalId'
      description: The template's organization-scoped external id.
      example: invoice-primary
    logId:
      name: logId
      in: path
      required: true
      schema:
        type: string
      description: Render log id.
    logSource:
      name: source
      in: query
      schema:
        type: string
        enum:
        - api
        - ui
        - mcp
      description: Where the render was triggered from.
    limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    organizationId:
      name: organizationId
      in: path
      required: true
      schema:
        type: string
      description: Your organization id. Must match the API key's organization.
      example: org_abc
  responses:
    InvalidExternalId:
      description: '`invalid_external_id`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_external_id
            message: externalId must be 1-128 characters using only ASCII letters, digits, '.', '_', '~', or '-', and cannot be '.' or '..'
    OrganizationScopeMismatch:
      description: The organization in the URL does not match the API key's organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: organization_scope_mismatch
            message: The organization in the URL does not match the API key organization
    TemplateNotFound:
      description: No template with that id is accessible to this key. Another user's draft is indistinguishable from a missing template.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Template not found
    Unauthorized:
      description: Missing, invalid or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: prs_...
      description: Organization-scoped API key, created under Settings → API Keys or with the MCP `create_api_key` tool.
externalDocs:
  description: 'API guide: authentication, errors, webhooks, MCP, migrating from v1'
  url: https://pdfs.build/docs/