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 File API API

The File API API from Writer — 4 operation(s) for file api.

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

Tagged areas include File API. 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 5 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 5 schemas 1 DELETE3 GET2 POST

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 File API 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 — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

File API 6
GET
/v1/files/{file_id}
Retrieve file
gatewayGetFile 1 param → 200
DELETE
/v1/files/{file_id}
Delete file
gatewayDeleteFile 1 param → 200
GET
/v1/files
List files
gatewayGetFiles 7 params → 200
POST
/v1/files
Upload file
gatewayUploadFile 4 params body → 200
GET
/v1/files/{file_id}/download
Download file
gatewayDownloadFile 1 param → 200
POST
/v1/files/retry
Retry failed files
gatewayRetryFailedFiles body → 200

Schemas 5

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

retry_files_response
object
1 property
retry_files_request
object
1 property 1 required
files_response
object
4 properties 2 required
file_response
object
5 properties 5 required
delete_file_response
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

writer-file-api-api-openapi.yml Raw ↑

Other APIs Writer publishes across the network.

Writer Generation API API
Writer KG API API
Writer template API
Writer Tools API API
Writer Translation API
Writer Vision API