Brand Brain Tools API (0.21.0)

Download OpenAPI specification:

Brand Brain: info@satalia.com URL: https://www.satalia.com License: Proprietary

Introduction

The Brand Brain Tools API provides a set of endpoints to interact with common tools used in the Brand Brain platform.

Extract

Content Extraction API for extracting content from various media types.

Submit a Content Extraction job

Submits a request to extract content from a specified source.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json

external_tracking_id	string non-empty Optional external job ID for internal tracking.
uri required	string <uri> non-empty The URI of the source content to extract.
extraction_model_name	string non-empty Default: "gpt-4.1" Enum: "gpt-4.1" "gpt-5-chat" The name of the extraction model to use.
callback_url	string <uri> (Callback URL) non-empty Webhook callback endpoint.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

Basic example

{"uri": "https://example.com"
}

Response samples

202
400

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "submitted"
}

Get a Content Extraction job

Retrieves the current status and result (if any) of an Content Extraction job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string <uuid>

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"status": "completed",
"result": ["string"
],
"failures": [{"code": "CONNECTION_ERROR",
"message": "string",
"detail": { }
}
]
}

Analysis

Brand Voice Analysis API for extracting a Brand Voice Guide from the given content.

Submit a Brand Voice Analysis job

Submits a request to extract a Brand Voice Guide from the given content

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json

external_tracking_id	string non-empty Optional external job ID for internal tracking.
required	Plain Text (string) or Structured Content (object) or Array of List of Structured Content (objects)
analysis_model_name	string non-empty Default: "gpt-4.1" Enum: "gpt-4.1" "gpt-5-chat" The name of the LLM to use for analysis.
callback_url	string <uri> (Callback URL) non-empty Webhook callback endpoint.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

Basic example

{"content": "Some plain text content."
}

Response samples

202
400

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "submitted"
}

Get a Brand Voice Analysis job

Retrieves the current status and result (if any) of a Brand Voice Analysis job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string <uuid>

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"status": "completed",
"result": {"tone_of_voice": "Casual and unprofessional",
"writing_style": "Flowery, bombastic, verbose",
"target_audience": "Impressionable audience",
"grammar": "Casual, informal usage of grammar and punctuation",
"emotional_tone": "Neutral",
"punctuation": "Maximise use of commas and full stops.",
"language": "Difficult to understand language. Use jargon and complex words.",
"pitch": "Extremely positive, overly optimistic",
"choice_of_words": "Use grandiose words and phrases. Avoid using simple or straightforward words.",
"use_of_emoticons": "Maximise use of emotions.",
"pattern": "Use long paragraphs and run-on sentences in order to increase word count.",
"industry": "Cosmetics"
},
"failures": [{"code": "CONNECTION_ERROR",
"message": "string",
"detail": { }
}
]
}

Analysis

Content Quality API for analysing and evaluating the quality of the content.

Submit a Content Quality Analysis Job

Submits a request to analyse the quality of text content.

Authorizations:

ApiGatewayApiKey

Request Body schema: application/json

external_tracking_id	string non-empty Optional external job ID for internal tracking.
required	Structured (object) or Text (string) (Content) The content to be analysed. Minimum content length is 150 characters. For structured payloads, the total of all string values is used.
	object (Config) non-empty The configuration for the content quality analysis job.
analysis_model_name	string non-empty Default: "gpt-4.1" Enum: "gpt-4.1" "gpt-5-chat" The name of the analysis model to use.
callback_url	string <uri> (Callback URL) non-empty Webhook callback endpoint.

Responses

Callbacks

Request samples

Payload

Content type

application/json

Example

Basic example

{"content": "Some text to analyse"
}

Response samples

202
400

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"
}

Callback payload samples

Callback

POST: Job Updates

Content type

application/json

{"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"status": "submitted"
}

Get a Content Quality Analysis job

Retrieves the current status and result (if any) of a Content Quality Analysis job.

Authorizations:

ApiGatewayApiKey

path Parameters

job_id

required

string <uuid>

Example: 13d87fb8-a940-447c-9755-dbe6c631ef57

The ID of the job to query.

Responses

Response samples

200
400
404

Content type

application/json

{"status": "completed",
"result": {"report": {"spell_check": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"grammar": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"sentence_length_variety": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"word_variability": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"over_repeated_words": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"keyword_phrase_matching": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"text_readability": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "FLESCH_READING_EASE",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
],
"failure_reason": "string"
},
"clarity": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
],
"failure_reason": "string"
},
"brand_voice_adherence": {"status": "ISSUES_FOUND",
"metrics": { },
"failure_reason": "string",
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
},
"relevance_and_coherence": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "RELEVANCE",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
],
"failure_reason": "string"
},
"originality_and_creativity": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "ORIGINALITY_AND_CREATIVITY",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
],
"failure_reason": "string"
},
"tone_and_style": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
],
"failure_reason": "string"
},
"text_flow": {"status": "ISSUES_FOUND",
"metrics": { },
"issues": [{"issue_type": "string",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
],
"failure_reason": "string"
},
"accuracy_of_information": {"status": "ISSUES_FOUND",
"metrics": { },
"failure_reason": "string",
"issues": [{"issue_type": "INACCURACY",
"location": "string",
"explanation": "string",
"suggestions": ["string"
]
}
]
}
},
"summary": "Your text has spelling errors and clarity issues that need attention. Consider fixing the misspelled words and rephrasing unclear sentences for better readability."
},
"failures": [{"code": "CONNECTION_ERROR",
"message": "string",
"detail": { }
}
]
}