SPA Brands

SPA: Suggest Brand CI settings from existing DOCX templates

Creates a SpaBrandCiSettingsSuggestion resource.

POST/api/spa/brands/{id}/ci-settings/suggest

SPA: Suggest Brand CI settings from existing DOCX templates

curl --request POST \
  --url 'https://app.output.rocks/api/spa/brands/string/ci-settings/suggest' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "locale": "en",
  "maxTemplates": 25
}'

201

application/json

{
  "id": 123,
  "ciSettings": [
    "string"
  ],
  "sourceTemplates": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "aiUsed": true,
  "confidence": "string"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

SpaBrandCiSettingsSuggestion identifier

Request Body

application/json

required

The new SpaBrandCiSettingsSuggestion resource

{
  "locale": "en",
  "maxTemplates": 25
}

Response

201application/json

SpaBrandCiSettingsSuggestion resource created

integer | null

ciSettings

string[] | null

sourceTemplates

string[] | null

warnings

string[] | null

aiUsed

boolean | null

Available options: truefalse

confidence

string | null