API referencePOST

Analyze website description

Generate an AI description from a URL before creating or updating a website.

POSThttps://ai.redreplier.com/ai-app/api/v1/websites/analyze-description

Generate an AI description from a URL before creating or updating a website.

Bearer Token (RedReplier API token)

Parameters

This endpoint does not take path or query parameters.

Request body

url (string, URL, required): Website URL to analyze.

Response

Returns the generated description.

description (string): AI-generated summary of the website or product.

Notes

Use this before create or update when you want to review the AI-generated description.

Errors

400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
401 Unauthorized: Missing or invalid Bearer token.
404 Not Found: The resource does not exist for the token account.
500 Internal Server Error: Unexpected server error.

Example request (curl)

curl --request POST \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/analyze-description \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"url": "https://acmecrm.io"}'

200

{
  "description": "Acme CRM helps small agencies manage sales pipelines, client relationships, and follow-up workflows."
}

Example request (curl)

curl --request POST \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/analyze-description \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"url": "https://acmecrm.io"}'

200

{
  "description": "Acme CRM helps small agencies manage sales pipelines, client relationships, and follow-up workflows."
}