Websites

Start monitoring a website

Adds a website and, when description is left out, scrapes the URL to write one so mention scoring knows what the product does. That scrape uses one AI generation from the plan quota; if it fails or the quota is exhausted the website is still created with description: null, so set one with PATCH or /websites/analyze-description. Send description: "" to create the website with no description and skip the scrape. Keywords supplied here are stored as PENDING and are not monitored until POST /keywords/activate-pending moves them into free slots on the plan.

post/websites

Request

  • Base URL: https://ai.redreplier.com/ai-app/api/v1
  • URL: https://ai.redreplier.com/ai-app/api/v1/websites
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

urlstring uri required
namestring
keywordsstring[]
descriptionstring

Set it yourself to skip scraping and AI generation. An empty string stores no description and also skips them; leaving the field out has RedReplier write one.

Response

Website created

idstring uuid required
accountGroupIdstring uuid
domainstring required
urlstring uri required
namestring nullable
descriptionstring nullable

Feeds mention scoring.

createdAtstring date-time nullable
updatedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.