Skip to content

Bug Reports ​

Report a bug in Rymi and follow what happens to it. Every report starts as pending_review: the Rymi team reads it before anyone works on it, then approves, rejects or marks it a duplicate. Approved reports move to in_progress and then fixed, with a link to the fix.

You can file a report from MCP (report_bug, see MCP), the REST API or the SDKs. Any secret key or Studio login for the workspace can file and read reports. Publishable keys cannot.

For account or billing questions, use Support instead.

Report a Bug ​

POST/v1/bug-reports

Request Body ​

FieldTypeRequiredDescription
titlestringyesOne line naming the problem, 3 to 200 characters
descriptionstringyesWhat went wrong, 10 to 5,000 characters
stepsstringnoHow to make it happen again, up to 5,000 characters
expectedstringnoWhat should have happened, up to 2,000 characters
actualstringnoWhat happened instead, up to 2,000 characters
severityenumnolow, medium (default), high or critical
areaenumnoagents, calls, voice_quality, campaigns, telephony, billing, mcp, api_sdk, studio or other (default)
call_iduuidnoA call in this workspace that shows the bug
agent_iduuidnoAn agent in this workspace the bug is about
sourceenumnomcp, api (default) or studio

You can't set status: a report always starts at pending_review. Don't put passwords, API keys or card numbers in a report.

Example Request ​

bash
curl -X POST https://api.rymi.live/v1/bug-reports \
  -H "Authorization: Bearer $RYMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Agent stops speaking mid-sentence on long answers",
    "description": "On calls longer than 2 minutes the Hindi agent cuts off halfway through its reply.",
    "steps": "1. Call +91 80655 84992\n2. Ask about EMI options\n3. Wait for the long answer",
    "severity": "high",
    "area": "voice_quality",
    "call_id": "3c643aa9-01fb-4571-9983-847c5760147d"
  }'
ts
const { bug_report } = await rymi.bugReports.create({
  title: "Agent stops speaking mid-sentence on long answers",
  description: "On calls longer than 2 minutes the Hindi agent cuts off halfway through its reply.",
  severity: "high",
  area: "voice_quality",
  call_id: "3c643aa9-01fb-4571-9983-847c5760147d",
});
python
result = rymi.bug_reports.create(
    "Agent stops speaking mid-sentence on long answers",
    "On calls longer than 2 minutes the Hindi agent cuts off halfway through its reply.",
    severity="high",
    area="voice_quality",
    call_id="3c643aa9-01fb-4571-9983-847c5760147d",
)

Response 201 ​

json
{
  "bug_report": {
    "id": "8f2e6c1a-4b7d-4e2f-9a31-6d5c2b1e0f47",
    "title": "Agent stops speaking mid-sentence on long answers",
    "description": "On calls longer than 2 minutes the Hindi agent cuts off halfway through its reply.",
    "steps": "1. Call +91 80655 84992\n2. Ask about EMI options\n3. Wait for the long answer",
    "expected": null,
    "actual": null,
    "severity": "high",
    "area": "voice_quality",
    "call_id": "3c643aa9-01fb-4571-9983-847c5760147d",
    "agent_id": null,
    "source": "api",
    "status": "pending_review",
    "duplicate_of": null,
    "fix_ref": null,
    "created_at": "2026-11-14T09:12:40Z",
    "updated_at": "2026-11-14T09:12:40Z"
  }
}

List Bug Reports ​

GET/v1/bug-reports

Reports filed from this workspace, newest first.

Query Parameters ​

ParameterTypeDefaultDescription
limitinteger20Max records, up to 100
offsetinteger0Records to skip
statusenumnoneOnly reports in this status
bash
curl "https://api.rymi.live/v1/bug-reports?status=pending_review" \
  -H "Authorization: Bearer $RYMI_SECRET_KEY"
ts
const { bug_reports, total } = await rymi.bugReports.list({ status: "pending_review" });
python
page = rymi.bug_reports.list(status="pending_review")

Response 200 ​

json
{
  "bug_reports": [{ "id": "8f2e6c1a-…", "title": "Agent stops speaking mid-sentence on long answers", "status": "pending_review", "…": "…" }],
  "total": 1,
  "limit": 20,
  "offset": 0
}

Get a Bug Report ​

GET/v1/bug-reports/:id

Returns { "bug_report": { … } } with the same fields as above. Node: rymi.bugReports.retrieve(id). Python: rymi.bug_reports.retrieve(id).


Status ​

statusMeaning
pending_reviewFiled. The Rymi team hasn't reviewed it yet
approvedConfirmed as a bug and queued for a fix
in_progressSomeone is fixing it
fixedFixed. fix_ref links to the change
rejectedNot a bug, or won't be fixed
duplicateAlready reported. duplicate_of is the earlier report

Errors ​

StatusWhen
400A field is missing, too long or not one of the allowed values, or call_id / agent_id isn't in this workspace
401No valid credential
403A publishable key was used
404No report with that id in this workspace
500The report couldn't be saved or loaded. Try again