Style guide API

Manage custom style guide rules over the HTTP API.

This command is action-based (not REST).

Command name: style_guide

See HTTP API Overview for endpoint, methods, and formats.

Authorization

An access key is required for this command. See Access key.

Rule identity and language

A style guide rule is scoped by language.

To uniquely target a rule, you need both:

• lang (language scope)

• rule (rule ID)

lang defaults to common.

It can also be:

• a language code like en_US

• a language group like en

Common parameters

Every action uses parameters listed below. For common parameters for all commands, see HTTP API Overview.

Parameter	Type	Required	Default	Notes
cmd	string	Yes	style_guide	Command name.
action	string	Yes		One of the actions below.
lang	string	No	common	Language scope for the rule set. Use en_US or en to target a specific language.
rule	string	Yes		Comma-separated list of rules

If you only know the text pattern but don’t have a rule ID yet, start with getrules.

lang is part of the rule identity. Same rule ID in a different lang scope is treated as a different target.

Actions

Action

Add rule

Description

Creates a new rule.

Docs

Add rule (addrule)

Action

Get rules

Description

Lists rules in the lang scope.

Docs

Get rules (getrules)

Action

Delete rule(s)

Description

Deletes rule(s) by ID and language.

Docs

Delete rule(s) (deleterule, deleterules)

Action

Edit rule

Description

Updates an existing rule by ID and language.

Docs

Edit rule (editrule)

Response format

Success responses share the same envelope and rule object schema.

See Response schema.

Errors and validation

• Errors

• Validation & limits