---
title: "Report a problem"
method: POST
path: "/v1/issue-reports"
tags: ["issue_reports"]
---

# Report a problem

`POST /v1/issue-reports`

## Request

- Base URL: `https://api.pomerado.ai`
- URL: `https://api.pomerado.ai/v1/issue-reports`
- Auth: HTTP bearer

Tell the Pomerado team about friction Pomerado caused, or something that worked notably well.

- Report each problem once, when it happens: something slow, an unexpected error, a confusing description or answer, a wrong result, or a design you had to work around. Not your own input mistakes, or website problems Pomerado explained.
- To change one tool, such as adding a filter, input or output, use POST /v1/tools/{id}/changes instead.
- Never include passwords, codes, tokens, card numbers, personal details, page content or your users' data.
- Pomerado attaches who sent the report and from where. It links the related job, tool and integration only when you can read them.
- The same report from you within a day counts again (status merged). Your account can send 50 reports an hour and 200 a day, across its members and clients; past that it answers report_limit_reached, and you carry on without retrying.
- Reports are kept 90 days and only help the Pomerado team improve Pomerado. They are not a support channel: if it is urgent, email founders@pomerado.ai (the receipt's message also gives the Discord invite).

## Request body

- IssueReportCreateRequest
  - `summary` string, required: One sentence saying what happened, 10 to 200 characters.
  - `category` 'slow' | 'error' | 'confusing' | 'workaround' | 'wrong_result' | 'missing_capability' | 'worked_well' | 'other', required: slow: a tool or job took too long. error: an error you didn't expect, or one that didn't say how to fix it. confusing: a description, input or answer that was unclear. workaround: you had to work around a design, with extra calls, guessing or retrying. wrong_result: a result was wrong. missing_capability: Pomerado can't do something you needed. worked_well: something worked notably well. other: anything else.
  - `task_outcome` 'completed' | 'completed_with_workaround' | 'partially_completed' | 'blocked': How your task ended: completed, completed_with_workaround, partially_completed or blocked.
  - `details` string: What you tried and what happened, up to 4,000 characters, quoting exact tool names, error codes and parameter names.
  - `suggested_improvement` string: The one change that would have helped, up to 1,000 characters.
  - `waited_seconds` integer: an integer
  - `related` object: What the report is about. Pomerado links only the IDs you can read.
    - `job_id` string: a job ID: job_ and 32 lowercase hex digits
    - `tool_id` string: a tool ID: tool_ and 32 lowercase hex digits
    - `integration_id` string: an integration ID: int_ and 32 lowercase hex digits
    - `tool` string: The name of the Pomerado tool or API operation the report is about, such as get_job.
    - `request_id` string: The request_id an error answered with, when it gave one.
    - `page` string: The page or screen the problem happened on, such as a Dashboard path.

## Response `201`

The stored report

- IssueReportReceipt
  - `report_id` string, required: The report's ID: rpt_ and 32 hex digits
  - `status` 'recorded' | 'merged', required: recorded: a new report. merged: you sent the same report within the last day, so it counted again
  - `severity` 'high' | 'medium' | 'low' | 'none', required: Derived by Pomerado: high for a blocked task; medium for a partial one, a workaround or an error on a job that failed on Pomerado's side; none for worked_well; otherwise low
  - `linked` object, required: The related IDs Pomerado kept; one you can't read is left out
    - `job_id` string, nullable, required: The related job, when you can read it
    - `tool_id` string, nullable, required: The related tool, when you can read it
    - `integration_id` string, nullable, required: The related integration, when you can read it
  - `message` string, required: What to do next

## Other responses

- `400`: invalid_request
- `401`: sign_in_required, unauthorized, reauthentication_required
- `403`: forbidden
- `413`: request_too_large
- `429`: report_limit_reached
- `500`: internal_error
- `503`: temporarily_unavailable

---

[API](https://skmtc.dev/pomerado/apis/pomerado-api.md) · [All operations](https://skmtc.dev/pomerado/apis/pomerado-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pomerado/apis/pomerado-api/revisions/c07cea59691c?raw)
