List style guides

GET

style-guides

curl --request GET \
  --url https://api.avidoai.com/v0/style-guides \
  --header 'x-api-key: <api-key>'

{
  "data": [],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 0,
    "totalPages": 0
  }
}

Authorizations

x-api-key

string

header

required

Your unique Avido API key

Query Parameters

skip

integer

default:0

Number of items to skip

Required range: x >= 0

Example:

0

limit

integer

default:25

Number of items per page

Required range: 1 <= x <= 100

Example:

25

orderBy

string

Field to order by

Example:

"createdAt"

orderDir

enum<string>

default:desc

Order direction

Available options:

asc,

desc

Example:

"desc"

Response

200

application/json

Successfully retrieved style guides

Paginated response containing style guides

data

object[]

required

A style guide for a specific application

data.id

string

required

The unique identifier of the style guide

Example:

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

data.createdAt

string

required

The date and time the style guide was created

Example:

"2024-01-01T00:00:00.000Z"

data.modifiedAt

string

required

The date and time the style guide was last updated

Example:

"2024-01-01T00:00:00.000Z"

data.content

object

required

The JSON content of the style guide

Example:

{
  "tone": "professional",
  "guidelines": [
    "Use clear and concise language",
    "Maintain consistent terminology"
  ]
}

data.application

object

required

Application configuration and metadata

data.quickstartId

string | null

required

The ID of the associated quickstart if any

Example:

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

data.definitions

object[]

required

pagination

object

required

Pagination metadata returned in a paginated response.

Get a single run by ID Create a new style guide

curl --request GET \
  --url https://api.avidoai.com/v0/style-guides \
  --header 'x-api-key: <api-key>'

{
  "data": [],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 0,
    "totalPages": 0
  }
}

Webhook

Applications

Threads

Ingestion

Tasks

Evals

Tests

Topics

Annotations

Runs

Style Guides

List style guides

Authorizations

Query Parameters

Response