API ReferenceStyle Guides

Create Style Guide

Create a new style guide that can be used in checks, suggestions, and rewrites.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a multipart form containing a file.
file_uploadfileRequired

The style guide you’d like to create. We accept PDFs (.pdf). File size limit: 2MB. Encoding: UTF-8 (standard for most text files).

namestringOptionalDefaults to
A friendly name for your style guide to help you identify it later. If left empty, we'll generate one for you.

Response

The style guide was created successfully and is being processed.
idstringformat: "uuid"
namestring
The name of the style guide.
created_atstringformat: "date-time"
The UTC date and time the style guide was created.
created_bystring
The ID of the user who created the style guide.
statusenum
The status of the submitted style guide.
Allowed values:
updated_atstring or nullformat: "date-time"
The UTC datetime that the style guide was last updated. If null, the style guide has never been updated.
updated_bystring or null
The ID of the user who last updated the style guide. If null, the style guide has never been updated.

Errors