POST
/
v1
/
evaluate
/
text
Evaluate Text Content
curl --request POST \
  --url https://api.adclear.ai/v1/evaluate/text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "Get 50% off your first order! Limited time offer.",
  "product_id": "123e4567-e89b-12d3-a456-426614174000",
  "adtype_id": "123e4567-e89b-12d3-a456-426614174001",
  "country_id": "123e4567-e89b-12d3-a456-426614174002"
}'
{
  "evaluation_id": "eval_123e4567-e89b-12d3-a456-426614174003",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "status": "success",
  "review_required": true,
  "issues": [
    {
      "suggestion": "Add clear terms and conditions link for the discount offer",
      "explanation": "Promotional claims require accessible terms and conditions to comply with advertising standards and ensure transparency for consumers."
    }
  ]
}
Evaluate text content against advertising compliance guidelines and regulations. This endpoint requires you to specify the product, ad type, and country context to ensure the correct rules are applied during evaluation. You’ll need to obtain the required IDs using the resource endpoints: The evaluation will return any compliance issues found, along with specific suggestions for improving your content.

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token

Body

application/json
​
content
string
required

The text content to be evaluated

Minimum length: 1
Example:

"Get 50% off your first order! Limited time offer."

​
product_id
string<uuid>
required

ID of the product for which the content is being evaluated

Example:

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

​
adtype_id
string<uuid>
required

ID of the ad type for which the content is being evaluated

Example:

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

​
country_id
string<uuid>
required

ID of the country for which the content is being evaluated

Example:

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

Response

Successful evaluation

​
evaluation_id
string
required

Unique identifier for this evaluation.

​
timestamp
string<date-time>
required

The UTC timestamp when the evaluation was completed.

​
status
enum<string>
required

Overall status of the evaluation. 'error' if any agent failed, 'success' otherwise.

Available options:
success,
error
​
review_required
boolean
required

Whether the evaluation identified issues that require manual review. This is true if any issues are found.

​
issues
object[]
required

A list of issues found during evaluation that need to be addressed.