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

Napkin Visuals API

Create, poll, and download programmatic visual generations.

Napkin Visuals API is published by Napkin on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Visuals. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.1.16.

Requests are made against a single base URL, https://api.napkin.ai.

3 operations 3 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.1.16
Base URL
https://api.napkin.ai
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Napkin Visuals API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes.

  • bearerAuth — Napkin account API token. Create one at app.napkin.ai - Account/Team Space Settings - Developers - "Create new API token". Send as: Authorization: Bearer YOURA…
  • oauth2 — OAuth 2.0 authorization code flow for acting on behalf of Napkin users. Applications must be approved by Napkin (contact api@napkin.ai) to obtain client creden…

Paths & Operations 3

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

Visuals 3

Create, poll, and download programmatic visual generations.

POST
/v1/visual
Create a visual request
createVisualRequest body → 201400401429500
GET
/v1/visual/{request-id}/status
Get visual request status
getVisualRequestStatus 1 param → 200400401403404410500
GET
/v1/visual/{request-id}/file/{file-id}
Download a generated file
downloadVisualFile 2 params → 200400401403404410500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are VisualRequestInput (15 properties), VisualRequestStatus (4 properties), VisualRequest (3 properties), GeneratedFile (3 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
Error object with codes and warning codes on visual request responses (since v0.12.0).
2 properties
GeneratedFile
object
A single generated output file for a completed request.
3 properties
VisualRequestStatus
object
Processing status of a visual request.
4 properties
VisualRequestInput
object
Parameters accepted by POST /v1/visual. Field set transcribed from the published API reference and changelog; only content is required.
15 properties 1 required
VisualRequest
object
Response returned when a visual request is accepted for processing.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

napkin-visuals-api-openapi.yml Raw ↑