Skip to main content
PUT
/
v0
/
style-guides
/
{id}
Update a style guide
curl --request PUT \
  --url https://api.avidoai.com/v0/style-guides/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "content": [
    {
      "heading": "Tone",
      "content": "Use professional and clear language",
      "approved": true
    },
    {
      "heading": "Guidelines",
      "content": "Maintain consistent terminology throughout",
      "approved": false
    }
  ]
}'
{
  "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
      },
      {
        "heading": "Guidelines",
        "content": "Maintain consistent terminology throughout",
        "approved": false
      }
    ],
    "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...",
      "language": "en",
      "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": "2024-01-05T12:34:56.789Z",
        "modifiedAt": "2024-01-05T12:34:56.789Z",
        "type": "NATURALNESS",
        "name": "<string>",
        "globalConfig": "<any>",
        "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "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...",
          "language": "en",
          "type": "CHATBOT",
          "environment": "DEV",
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z"
        }
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Path Parameters

​
id
string<uuid>
required

The unique identifier of the style guide

Example:

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

Body

application/json

Request body for updating a style guide

​
content
object[]
required

The updated content sections of the style guide

Example:
[
  {
    "heading": "Tone",
    "content": "Use professional and clear language",
    "approved": true
  },
  {
    "heading": "Guidelines",
    "content": "Maintain consistent terminology throughout",
    "approved": false
  }
]

Response

Successfully updated style guide

Successful response containing the style guide data

​
data
object
required

A style guide for a specific application

⌘I