AI copy · Ready Docs

#AI copy

#Write message drafts

POST/sms/generate

Writes up to 5 draft texts from a short description.

Cost 5 × your per-segment rate (no carrier fee)

Important. Idempotency-Key isn't supported here, so a retry is a new charge.

Body parameters

descriptionstringRequired: What the message should say. The only field accepted.

Returns

datastring[]: Usually 5 drafts.
Details
Rarely, an item is a stray line such as "Reply STOP to opt out.", so drop very short items.
credits_remaininginteger: At the top level, not in data.

Errors

HTTP	Code	When
200	`generation_refused`	Breaks texting rules. Not refunded. Details Body has `"success": false` and `"refused": true`.
400	no code	`description` is missing or empty (`Describe the message you want us to write.`).
400	`invalid_field`	`description` is an object or array.
400	`unknown_field`	A field other than `description`.
402	no code	Balance too low (`Insufficient balance. Add funds in Billing.`).
402	`BILLING_PAST_DUE`	Payment failed, no balance. Also `FRAUD_HOLD`.
403	`permission_denied`	The key's user lacks `send_sms`.
500	`generation_failed`	Refunded. Retry.

POST /sms/generate

curl -X POST "https://api.tryready.com/sms/generate" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Remind patients about their cleaning next week and ask them to reply C to confirm"
  }'

const res = await fetch('https://api.tryready.com/sms/generate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "description": "Remind patients about their cleaning next week and ask them to reply C to confirm"
  }),
});
const json = await res.json();
if (!res.ok || json.success === false) {
  throw new Error(`${res.status} ${json.error_code || json.code}: ${json.error}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/sms/generate",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "description": "Remind patients about their cleaning next week and ask them to reply C to confirm"
    },
    timeout=30,
)
data = r.json()
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code")}: {data.get("error")}')

Response

{
  "success": true,
  "data": [
    "Hi! Your cleaning is next week. Reply C to confirm or call us to reschedule.",
    "…",
    "…",
    "…",
    "…"
  ],
  "credits_remaining": 1234
}