Docsary
Markdown Ask Claude Ask ChatGPT
On this page

Support

File a bug or feature request through the API, then check its status with your organization key.

For account access, billing, or quota questions, email hello@robota.us. For abuse or legal notices, follow Report abuse.

Report a bug

curl -s -X POST "$DOCSARY_API/v1/reports" \
  -H "authorization: Bearer $DOCSARY_KEY" \
  -H "content-type: application/json" \
  -d '{
    "kind": "bug",
    "title": "Search returns nothing for hyphenated terms",
    "body": "Searching for drop-in on our site returns zero results, but drop in finds the same page. Two versions, both affected. Started some time last week.",
    "page_url": "https://docs.acme.com/guide/search",
    "contact": "docs@acme.com"
  }'
{
  "id": "rep_9f2c4a1b7e6d8035c1a4b9e2f7d60a83",
  "kind": "bug",
  "title": "Search returns nothing for hyphenated terms",
  "status": "open",
  "created_at": 1756300000000,
  "email": { "status": "sent" }
}

Save the id to refer to your report later.

Request a feature

Same call, kind set to feature:

curl -s -X POST "$DOCSARY_API/v1/reports" \
  -H "authorization: Bearer $DOCSARY_KEY" \
  -H "content-type: application/json" \
  -d '{
    "kind": "feature",
    "title": "Mark a version deprecated without deleting it",
    "body": "We keep three released versions live for customers on older hardware. We would like a banner on the two older ones saying they are superseded, without unpublishing them or hand-editing every page.",
    "contact": "docs@acme.com",
    "meta": { "versions_live": 3 }
  }'

Describe what you need to accomplish, your current workaround, and where it fails.

What is required

Field Required Notes
kind yes bug or feature
title yes One line, 3–200 characters
body yes 10–10000 characters. The detail goes here
page_url no The page it is about — worth including for anything visible on a site
contact no Where you want the reply. Without it we can read the report but not answer it
meta no Any small object: client, version, browser

Any valid organization key can file a report, including a read-only key.

For a bug, the three things that shorten the round trip most: the URL, what you expected, and what happened instead. If it only happens on one version or one page, say which.

What happens next

The response confirms that your report was saved. Its email.status shows whether the notification was sent, skipped, or failed; a failed notification does not remove the report.

Include contact if you want a reply. You can also check the report's status through the API.

Check on your reports

curl -s -H "authorization: Bearer $DOCSARY_KEY" \
  "$DOCSARY_API/v1/reports"
{
  "reports": [
    {
      "id": "rep_9f2c4a1b7e6d8035c1a4b9e2f7d60a83",
      "kind": "bug",
      "title": "Search returns nothing for hyphenated terms",
      "status": "open",
      "created_at": 1756300000000
    }
  ],
  "next_offset": null
}

Newest first, and only your organization's own reports. Filter with ?status=open, ?status=triaged, or ?status=closed.

status Meaning
open Received, not yet looked at
triaged Read and understood, and on a list
closed Done, or decided against

We update report status. If a closed issue persists, file a new report and quote the original id.

Limits

An organization may file 20 reports an hour. Past that the call returns 429 and says so; nothing is stored and your earlier reports are untouched. If you have a genuine batch to file, ask us instead of looping.

The full request and response shapes, every validation rule, and every error are in the Reports API reference.

What this is not

There is no uptime or response-time guarantee. If a site is unavailable, file a bug with its hostname.

Reports are visible to us and attributed to your organization. Do not include credentials or unnecessary personal data.

For organization changes, see Pricing and access.