RaabtaHQ
Get a library instruction

Get a library instruction

GET/api/v1/instructions/{id}

scope assistants:read

One instruction, with how many assistants carry it.

Path parameters

NameTypeDescription
idrequired
string (uuid)Instruction id
Request
curl "https://your-crm.example.com/api/v1/instructions/5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f" \
  -H "Authorization: Bearer $RAABTA_API_KEY"
Response · 200 OK
{
  "data": {
    "id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
    "title": "Refund policy",
    "description": "How to answer anyone asking about refunds or cancellations",
    "content": "Treatments cancelled more than 24 hours ahead are refunded in full. Inside 24 hours we offer a reschedule, not a refund. Never promise an exception — hand off instead.",
    "assistant_count": 2,
    "created_at": "2026-08-02T10:00:00.000Z",
    "updated_at": "2026-08-20T14:00:00.000Z"
  }
}

Response

Wrapped in { data: … }
NameTypeDescription
idrequired
string (uuid)Instruction id
titlerequired
stringLibrary title
descriptionrequired
stringOne line on when it applies
contentrequired
stringThe instruction text given to the model
assistant_countrequired
integerAssistants this instruction is bound to
created_atrequired
string (date-time)When it was created
updated_atrequired
string (date-time)When it was last edited

Errors

StatusCodeWhen
400validation_errorThe body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401unauthorizedNo usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403forbiddenThe key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403account_suspendedThe account this key belongs to is suspended. Rotating the key will not help; contact support.
404not_foundNo such resource in this account. A resource that exists in another account also returns this.
429rate_limitedThe per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500internalSomething failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.