Skip to main content
PUT
Upsert error recommendation

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Path Parameters

errorID
string
required

Error ID (format err-<number>).

Body

application/json
action
enum<string>
required

Recommended handling of the error.

Available options:
ignore,
observe,
fix
summary
string
required

One-line summary of the recommendation.

explanation
string

What happens and why (root cause), as markdown.

reproduction
string

Preconditions and steps to reproduce, as markdown.

fixDetails
string

The recommended fix in detail, as markdown. Required when action is fix.

source
enum<string>

Provenance of the recommendation content; defaults to manual.

Available options:
manual,
ai-draft
annotationID
string

Annotation marking that the recommended action was carried out (format ann-<number>) — linking it IS resolving the recommendation. Must exist in the project. Omitting it on a later upsert reopens (the annotation itself is untouched).

Response

The stored recommendation.

Curated guidance attached to an error (at most one per error): what the error is and how to reproduce it, the recommended handling (ignore / observe / fix), and — for fix — the fix in detail. Human-created like the error itself; classification never writes it. Free-text fields are markdown.

id
string
required

Recommendation ID (format erc-<number>).

action
enum<string>
required

Recommended handling of the error.

Available options:
ignore,
observe,
fix
summary
string
required

One-line summary of the recommendation.

source
enum<string>
required

Provenance of the recommendation content.

Available options:
manual,
ai-draft
createdMs
integer<int64>
required

Creation time in milliseconds since epoch.

updatedMs
integer<int64>
required

Last update time in milliseconds since epoch.

explanation
string

What happens and why (root cause), as markdown.

reproduction
string

Preconditions and steps to reproduce, as markdown.

fixDetails
string

The recommended fix in detail, as markdown. Present when action is fix.

annotationID
string

ID of the annotation marking that the recommended action was carried out (format ann-<number>). Its presence IS the resolved state: the annotation's date is when, its description what was done. Absent while still open. The link survives the annotation's deletion; annotation is then absent.

annotation
object
assets
object[]

Media assets (screenshots, videos) attached to this recommendation, oldest first. Only confirmed (ready) uploads appear. View URLs are minted per asset via the downloadUrl endpoint.

Maximum array length: 100