Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Hiloop API key sent as an HTTP Bearer token.

Body

application/json
title
string

A short summary of the report. Required; at most 300 characters.

surface
string

The product surface the report is about. Required; one of cli, api, web, sandbox, telemetry, annotations, docs, or other.

severity
string

How severe the problem is. Optional; one of critical, high, medium, or low. Leave it empty for general feedback that is not a bug.

body
string

Free-form feedback text. Optional; at most 10,000 characters.

expected
string

What was expected to happen. Optional; at most 10,000 characters.

actual
string

What actually happened. Optional; at most 10,000 characters.

repro
string

Steps to reproduce the problem. Optional; at most 10,000 characters.

evidence
string[]

Correlation keys — run, event, or artifact ids — linking the report to recorded telemetry. Optional; at most 50 entries, each at most 256 characters.

fingerprint
string

A stable, content-derived deduplication key (for example <surface>/<short-slug>). Enforced: a submission whose fingerprint already exists returns the original report's id instead of storing (and surfacing) a duplicate, which makes retrying a lost response safe. When omitted, the server derives one from the report's content, so re-sending an identical report also converges. Optional; at most 300 characters.

hiloop_version
string

The hiloop client version that produced the report. Optional; at most 100 characters.

Response

OK

id
string

The stored report's id.

relayed
boolean

Whether the report was surfaced to the team's review channel. The report is stored either way, so a false here never means the feedback was lost.