Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

API Snap Documents API

Document generation and conversion (PDF, Markdown)

API Snap Documents API is one of 5 APIs that API Snap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 14 JSON Schema definitions.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 14 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api-snap.com.

2 operations 2 paths 2 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api-snap.com/api
Authentication
HTTP Bearer
License
Proprietary
Resource Areas
1

Authentication & Security 1

API Snap Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — API key obtained from your API Snap dashboard. Pass as Authorization: Bearer header or as ?apikey= query parameter.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 2

Document generation and conversion (PDF, Markdown)

POST
/api/pdf
Convert HTML to PDF
htmlToPdf body → 200400401429
POST
/api/markdown
Convert Markdown to HTML
markdownToHtml body → 200400401429

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are RateLimitError (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property 1 required
RateLimitError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

api-snap-documents-api-openapi.yml Raw ↑

Other APIs API Snap publishes across the network.

API Snap Browser API
API Snap Images API
API Snap Security API
API Snap Utilities API