JAjasper
Styles

Retrieve style guide by ID

Changed on

Returns a single style guide available to your workspace, fetched by its ID.

get/v1/styles/{styleId}

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/styles/{styleId}
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Path parameters

styleIdstring required

Response

The requested style guide.

idstring required

The style guide's unique ID

namestring required

The style guide's name

descriptionstring required

The style guide's description

customInstructionsobject nullable required

Free-form custom instructions for the style guide

createdAtstring required

When the style guide was created

createdByobject nullable required

The user ID of who created the style guide

updatedAtstring required

When the style guide was last updated

appUrlstring required

The client URL to view the style guide in the Jasper app. Empty when no link can be resolved.

termsstring[] required
rulesstring[] required

Example response

{
  "id": "sty_f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0",
  "name": "My Style Guide",
  "description": "A style guide for marketing content",
  "createdAt": "2025-01-15T12:00:00.000Z",
  "updatedAt": "2025-01-20T14:30:00.000Z",
  "appUrl": "https://app.jasper.ai/jasper-iq/style-guides/sty_f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0",
  "terms": [
    {
      "type": "REPLACE",
      "term": "waz",
      "replaceWith": "What's"
    },
    {
      "type": "ABBREVIATE_AFTER_FIRST",
      "term": "Mergers & Acquisitions",
      "replaceWith": "M&A"
    },
    {
      "type": "REPLACE_FIRST_INSTANCE",
      "term": "Jasper®",
      "replaceWith": "Jasper"
    }
  ],
  "rules": [
    {
      "name": "activeVoice",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "contractions",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "emDashAside",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "emDashSpaces",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "enDashRanges",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "exclamationPoints",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "formatNumerals",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "locale",
      "type": "locale",
      "value": "EN_US",
      "ignore": "enabled"
    },
    {
      "name": "oxfordComma",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "removeAmpersands",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "removePlusAsAnd",
      "type": "boolean",
      "value": true,
      "ignore": "enabled"
    },
    {
      "name": "removeSemicolons",
      "type": "boolean",
      "value": false,
      "ignore": "disabled"
    },
    {
      "name": "spacesAfterPeriod",
      "type": "number",
      "value": 1,
      "ignore": "disabled"
    },
    {
      "name": "spellNumbers",
      "type": "number",
      "value": 100,
      "ignore": "enabled"
    }
  ]
}

Changes

  • 3d5be7408661Revision changes
    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • info

      added the required property to the response with the status