Quick answer
The most common API responses questions are format, quality, permissions, batch failures and privacy. API types should cover errors/pagination/optional fields.
Why it matters
Checking these high-frequency issues solves most cases.
Error responses need types too.
Step by step
- Start with real/complete JSON covering optional fields and empty arrays.
- Check array elements, null/optional and nested objects.
- Set the root name and copy into the project.
- Add Zod/Valibot runtime validation for production.
- Add contract tests/versioning for API changes.
Common mistakes
- Treating a sample as a complete schema, missing optional/empty arrays.
- Trusting generated any/null unions as-is.
- Forgetting quotes for property names with spaces/Chinese.
- Skipping runtime validation after generation.
Checklist
- Sample covers optional/empty arrays/null.
- Array object fields merged.
- Property/root names valid.
- Runtime validation added.
- API contract/version considered.
Key facts
- Error responses need types too.
- Pagination fields may be absent.
FAQ
What are common API responses questions?
The most common API responses questions are format, quality, permissions, batch failures and privacy. API types should cover errors/pagination/optional fields.
How long does it take?
Usually 1-3 minutes; for intermittent issues, run 30 seconds and retest elsewhere.
Is data uploaded?
Runs locally and does not upload video/audio; extensions may still read the page.
Source: OpenAPI