Brand Kits

Endpoints for managing brand kits and their associated resources.

List Brand Kits

post

Brand Kits for AEO operations — provides the brand_kit_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

workspace_idintegerOptional

ID of the workspace to retrieve brand kits from. If not provided, returns brand kits from all workspaces the user belongs to.

sortstring · enumOptional

Sort field. Prefix with - for descending.

Available sort fields:

• brand_name/-brand_name: Sort alphabetically by brand name
• created_at/-created_at: Sort by creation date
• prompts_count/-prompts_count: Sort by number of prompts/questions

Possible values:

pageintegerOptional

Page number

Default: 1

per_pageinteger · max: 100Optional

Items per page

Default: 25

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

post/public_api/brand_kits/list

POST /public_api/brand_kits/list HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "workspace_id": 1,
  "filters": [
    {
      "field": "workspace_name",
      "operator": "EQUALS",
      "value": null
    }
  ],
  "includes": [
    "product_lines"
  ],
  "fields": [
    "brand_url"
  ],
  "sort": "brand_name",
  "page": 1,
  "per_page": 25
}

{
  "data": [
    {
      "id": 1,
      "workspace_name": "text",
      "brand_name": "text",
      "brand_url": "text",
      "brand_about": "text",
      "brand_customer": "text",
      "brand_competitors": "text",
      "brand_point_of_view": "text",
      "writing_persona": "text",
      "writing_tone": "text",
      "writing_cta": "text",
      "writing_cta_url": "text",
      "writing_rules": "text",
      "writing_sample_title": "text",
      "writing_sample_outline": "text",
      "writing_sample_body": "text",
      "writing_sample_url": "text",
      "primary_color": "text",
      "secondary_color": "text",
      "accent_color": "text",
      "header_case": "text",
      "header_case_custom_value": "text",
      "countries": [
        "text"
      ],
      "aeo_enabled": true,
      "prompts_count": 1,
      "created_at": "text",
      "updated_at": "text",
      "product_lines": [
        {}
      ],
      "competitors": [
        {}
      ],
      "audiences": [
        {}
      ],
      "content_types": [
        {}
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Get Brand Kit

get

Brand Kits for AEO operations — provides the brand_kit_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

The resource ID

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

get/public_api/brand_kits/{id}

GET /public_api/brand_kits/{id} HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "workspace_name": "text",
    "brand_name": "text",
    "brand_url": "text",
    "brand_about": "text",
    "brand_customer": "text",
    "brand_competitors": "text",
    "brand_point_of_view": "text",
    "writing_persona": "text",
    "writing_tone": "text",
    "writing_cta": "text",
    "writing_cta_url": "text",
    "writing_rules": "text",
    "writing_sample_title": "text",
    "writing_sample_outline": "text",
    "writing_sample_body": "text",
    "writing_sample_url": "text",
    "primary_color": "text",
    "secondary_color": "text",
    "accent_color": "text",
    "header_case": "text",
    "header_case_custom_value": "text",
    "countries": [
      "text"
    ],
    "aeo_enabled": true,
    "prompts_count": 1,
    "created_at": "text",
    "updated_at": "text",
    "product_lines": [
      {}
    ],
    "competitors": [
      {}
    ],
    "audiences": [
      {}
    ],
    "content_types": [
      {}
    ]
  }
}