API reference
Document auth, conventions, error codes, and each endpoint's parameters and examples so developers can complete the integration on their own.
Prompt
Write API documentation for a loyalty points system's public API. Purpose: let partner developers integrate on their own. Requirements: give base URLs per environment, authentication and common conventions (request format, pagination, idempotency, rate limits, time format), an error code table and endpoint index; for each endpoint, the method and path, request parameter and response field tables, and success and error examples; for webhooks, signature verification and retries; plus a changelog. Be exact about types and required fields, use placeholder keys, and keep it concise.
- Source
- Ofox
How to use
- 1
Tap “Make one like this”
Ofox Chat opens with this document’s structure ready to go. Sign in first if you haven’t.
- 2
Make it yours
Edit the highlighted parts of the prompt to swap in your own details.
- 3
Send and create
Send it and Ofox Chat writes the full document for you to download. Keep chatting to revise it.
FAQ
What kind of file do I get?
A complete, downloadable document (Word or PDF) — not just a block of text in the chat.
Do I need to prepare anything?
No — you can send it right away and Ofox Chat writes a first version from the template. Add your background, data or existing documents (paste them in, or upload PDFs, Word files and more) and the result fits your situation much better.
Can I edit the prompt?
Yes. The prompt goes into the Ofox Chat input box — swap in your own topic, add requirements or drop what you don’t need before sending.
Can I copy and use the prompt directly?
Yes. Tap “Copy” on the prompt card to get the plain text — it works in other AI writing tools too.
More like this
More Engineering prompts- Technical design docExplain how a system or feature will be built—architecture, data model, APIs and alternatives—and assess performance, risks, rollout and rollback.Engineering
- Incident postmortemReconstruct a production incident on a timeline, quantify its impact, trace the root cause, and set owned, dated actions to prevent a repeat.Engineering
- Technology evaluationWeigh candidate technologies against criteria set by business needs, score them with evidence, and recommend one with risks and a rollout plan.Engineering
- Test planDefine what to test, how, where, and when testing is done for a release or project, aligning QA, engineering and product on expectations.Engineering
- Release runbookTurn a deployment into a step-by-step runbook: pre-release checks, numbered steps, post-release verification, and rollback with clear triggers.Engineering
- Coding standardsSet shared coding standards: rules ranked must vs. should for naming, structure, error handling, security and reviews, each with examples.Engineering
- Database design docDocument the data layer: entity relationships, tables and constraints, the query behind each index, volume estimates and archiving.Engineering
- Migration planPlan a system or data migration: inventory, strategy, data sync and validation, phased cutover, and rollback at every stage.Engineering
- Performance test reportReport a performance test: throughput, latency percentiles and resource use against targets, the bottlenecks found, and a go/no-go call.Engineering
- Security reviewWrite up a security assessment: scope, threat model, findings with risk ratings and evidence, fixes, and a remediation and retest plan.Engineering
Have an idea of your own? Start creating
Describe the image you want in one sentence, and Ofox Chat creates it from scratch.