Create a new style guide

Creates a new style guide.

POST /v0/style-guides

JavaScript

JavaScript

import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const styleGuide = await client.styleGuides.create({
  content: [{ content: 'Use professional and clear language', heading: 'Tone' }],
});

console.log(styleGuide.data);

201

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org-123",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "content": [
      {
        "heading": "Tone",
        "content": "Use professional and clear language",
        "approved": true
      }
    ],
    "quickstartId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Body

application/json

Request body for creating a new style guide

content · Style Guide Section Input · object[] · required

Show child attributes

Response

201

application/json

Successfully created style guide

Successful response containing the style guide data

data · Style Guide · object · required

A style guide for a specific application

Show child attributes