Integrate
API contract
Pre-v1 API notes for private-alpha Error Decoder workflows, feedback and report-shaped output.
Use when
- You are wiring a private-alpha integration or evaluating the output shape.
- You need endpoint names, auth expectations and retry boundaries.
- You want to understand why reports are structured instead of free-form chat text.
Outcome
- The gateway boundary is clear before integration work starts.
- Feedback endpoints and authenticated decoder/report endpoints are separated.
- Export formats and report fields are visible in one place.
Endpoint families
- Error Decoder messages and toolchain error explanation endpoints.
- Feedback and heartbeat messages with public alpha limits.
- Authenticated report fetch/export and admin surfaces.
Client rules
- Use idempotency keys on retryable authenticated analysis/upload requests.
- Debounce public feedback retries client-side.
- Expect payload limits, rate limits and abuse monitoring during alpha.
Hosted boundary
- Hosted public cloud does not run proprietary vendor tools by default.
- Vendor tool execution requires local, enterprise or on-prem setup with appropriate licenses.
- Telegram delivery is owned by the separate fpgabot service.