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

Templafy Documents API

The Documents API from Templafy — 3 operation(s) for documents.

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

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against a single base URL, https://{tenantId}.api.templafy.com/v3.

6 operations 3 paths 8 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v3
Base URL
https://api.templafy.com/v3
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Templafy Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth).

Paths & Operations 6

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

Documents 6
POST
/libraries/{spaceId}/documents/assets/{assetId}/generate
Generates a document from a template and returns information about the file, which includes the download url.
2 params body → 200400401403404
GET
/libraries/{spaceId}/documents/folders/{folderId}/assets
Lists all document templates in the folder.
5 params → 200400401403404
POST
/libraries/{spaceId}/documents/folders/{folderId}/assets
Uploads the document template.
2 params body → 201400401403404409
GET
/libraries/{spaceId}/documents/assets/{assetId}
Returns the document template by the identifier.
2 params → 200401403404
PATCH
/libraries/{spaceId}/documents/assets/{assetId}
Updates the document template.
2 params body → 204400401403404409
DELETE
/libraries/{spaceId}/documents/assets/{assetId}
Deletes the document template by the identifier.
2 params → 204401403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are DocumentDetails (13 properties), Document (12 properties), ValidationProblemDetails (7 properties), NotFoundProblemDetails (6 properties). Each schema is shown below with its type and property counts.

NotFoundProblemDetails
object
6 properties
GenerateFileRequest
object
The request model to generate a file.
3 properties 1 required
Document
object
12 properties 11 required
ValidationProblemDetails
object
7 properties
AssetFileStateWithoutPreviews
string
The current state of the asset
DocumentDetails
object
13 properties 12 required
ConflictProblemDetails
object
6 properties
GeneratedFile
object
The generated file response model.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

templafy-documents-api-openapi.yml Raw ↑

Other APIs Templafy publishes across the network.

Templafy DataSourceFields API
Templafy DataSourceItemFields API
Templafy DataSourceItems API
Templafy DataSources API
Templafy EmailElements API
Templafy Folders API
Templafy Images API
Templafy Libraries API
Templafy Links API
Templafy Pdfs API
Templafy Presentations API
Templafy SlideElements API