Agent-readable docs index: /docs/llms.txt. Full docs in one file: /docs/llms-full.txt. Download /docs/docs.zip to grep all markdown files locally.

Preview rules

/segments/previewPOST
Queues a background preview of the submitted definition. Required scope: segments:write.
Authorization
BearerAuth *Bearer <token>
API key generated under Account Settings → API Keys (rk_live_...). Send as header Authorization: Bearer <key>.
Request Bodyapplication/jsonrequired
segment *object
Show properties
name *string
description?string
purpose?"marketing" | "transactional"
rules *object
source *object
Response
200 · Successful response. See the integration guide for status and lifecycle semantics.
Type: object
401 · Invalid, expired, revoked or missing key.
Invalid, expired, revoked or missing key.
403 · Required scope not granted.
Required scope not granted.
422 · Validation or eligibility failure.
Validation or eligibility failure.
Request example
curl -X POST "https://convert.ruut.chat/api/v1/segments/preview" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "segment": {
    "name": "string",
    "description": "string",
    "purpose": "marketing",
    "rules": {},
    "source": {}
  }
}'