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

Writer template API

The template API from Writer — 4 operation(s) for template.

Writer template API is one of 7 APIs that Writer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include template. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

6 operations 4 paths 9 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.writer.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Writer template API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication header of the form Bearer , where is your [Writer API key](https://dev.writer.com/api-reference/api-keys).

Paths & Operations 6

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

template 6
GET
/v1/applications/{application_id}/jobs
Retrieve all jobs
4 params → 200
POST
/v1/applications/{application_id}/jobs
Generate from application (async)
1 param body → 202
POST
/v1/applications/jobs/{job_id}/retry
Retry job execution
1 param → 202
GET
/v1/applications/jobs/{job_id}
Retrieve a single job
1 param → 200
GET
/v1/applications/{application_id}/graphs
Retrieve graphs
1 param → 200
PUT
/v1/applications/{application_id}/graphs
Associate graphs
1 param body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are get_async_application_job_response (8 properties), get_async_application_jobs_response (3 properties), generate_application_async_response (3 properties), generate_application_response (2 properties). Each schema is shown below with its type and property counts.

application_graph_ids_request
object
1 property 1 required
generate_application_async_request
object
1 property 1 required
get_async_application_job_response
object
8 properties 4 required
get_async_application_jobs_response
object
3 properties 1 required
generate_application_input
object
2 properties 2 required
application_graphs_response
object
1 property 1 required
api_job_status
string
The status of the job.
generate_application_response
object
2 properties 1 required
generate_application_async_response
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

writer-template-api-openapi.yml Raw ↑

Other APIs Writer publishes across the network.

Writer File API API
Writer Generation API API
Writer KG API API
Writer Tools API API
Writer Translation API
Writer Vision API