Speakeasy Reports API

REST APIs for managing reports (lint reports, change reports, etc)

Documentation GitHub OpenAPI

Operations 3

POST /v1/reports Upload a report. #

GET /v1/reports/linting/{documentChecksum} Get the signed access url for the linting reports for a particular document. #

GET /v1/reports/changes/{documentChecksum} Get the signed access url for the change reports for a particular document. #

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/speakeasy-api-reports-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:
  description: The Subscriptions API manages subscriptions for CLI and registry events
  title: Speakeasy Artifacts Reports API
  version: 0.4.0
servers:
- url: https://api.prod.speakeasy.com
  x-speakeasy-server-id: prod
security:
- APIKey: []
- WorkspaceIdentifier: []
- Bearer: []
tags:
- description: REST APIs for managing reports (lint reports, change reports, etc)
  name: Reports
paths:
  /v1/reports:
    post:
      summary: Upload a report.
      operationId: uploadReport
      requestBody:
        description: The report file to upload provided as a multipart/form-data file segment.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/Report'
                file:
                  format: binary
                  type: string
              required:
              - data
              - file
        required: true
      responses:
        2XX:
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: uploadedReport
                properties:
                  url:
                    type: string
                required:
                - url
      tags:
      - Reports
  /v1/reports/linting/{documentChecksum}:
    get:
      summary: Get the signed access url for the linting reports for a particular document.
      operationId: getLintingReportSignedUrl
      parameters:
      - description: The checksum of the document to retrieve the signed access url for.
        in: path
        name: documentChecksum
        required: true
        schema:
          type: string
      responses:
        2XX:
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: signedAccess
                properties:
                  url:
                    type: string
                required:
                - url
      tags:
      - Reports
  /v1/reports/changes/{documentChecksum}:
    get:
      summary: Get the signed access url for the change reports for a particular document.
      operationId: getChangesReportSignedUrl
      parameters:
      - description: The checksum of the document to retrieve the signed access url for.
        in: path
        name: documentChecksum
        required: true
        schema:
          type: string
      responses:
        2XX:
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: signedAccess
                properties:
                  url:
                    type: string
                required:
                - url
      tags:
      - Reports
components:
  schemas:
    Report:
      type: object
      properties:
        type:
          type: string
          enum:
          - linting
          - changes
  securitySchemes:
    APIKey:
      description: The API Key for the workspace
      in: header
      name: x-api-key
      type: apiKey
    WorkspaceIdentifier:
      description: The API Key for the workspace
      in: header
      name: x-workspace-identifier
      type: apiKey
    Bearer:
      description: The Bearer token for the workspace
      type: http
      scheme: bearer
externalDocs:
  url: /docs
  description: The Speakeasy Platform Documentation
x-speakeasy-globals:
  parameters:
  - name: workspace_id
    in: path
    schema:
      type: string