POST
/
v0
/
style-guides
curl --request POST \
  --url https://api.avidoai.com/v0/style-guides \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '{
  "content": {
    "tone": "professional",
    "guidelines": [
      "Use clear and concise language",
      "Maintain consistent terminology"
    ]
  },
  "applicationId": "456e4567-e89b-12d3-a456-426614174000"
}'
{
  "styleGuide": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "modifiedAt": "2024-01-01T00:00:00.000Z",
    "content": {
      "tone": "professional",
      "guidelines": [
        "Use clear and concise language",
        "Maintain consistent terminology"
      ]
    },
    "application": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "title": "Customer Support Bot",
      "slug": "customer-support-bot",
      "description": "AI assistant for customer support inquiries",
      "context": "You are a helpful customer support assistant...",
      "type": "CHATBOT",
      "environment": "DEV",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z"
    },
    "quickstartId": "123e4567-e89b-12d3-a456-426614174000",
    "definitions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "<string>",
        "modifiedAt": "<string>",
        "type": "GEVAL",
        "name": "<string>",
        "globalConfig": "<any>",
        "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique application ID. Get this from the Connections page in Avido.

Body

application/json

Request body for creating a new style guide

​
content
object
required

The JSON content of the style guide

Example:
{
  "tone": "professional",
  "guidelines": [
    "Use clear and concise language",
    "Maintain consistent terminology"
  ]
}
​
applicationId
string
required

ID of the application this style guide belongs to

Example:

"456e4567-e89b-12d3-a456-426614174000"

Response

201
application/json
Successfully created style guide

Successful response containing the style guide data

​
styleGuide
object
required

A style guide for a specific application

List style guidesGet a single style guide by ID