← Back to portfolio

Writing Sample

API Quick Start

This sample demonstrates how I structure a concise developer onboarding guide to help users achieve a first successful API request with minimal friction.

Hero visual for the API Quick Start sample
AudienceDevelopers
Content typeQuick start guide
GoalFirst successful request
FocusSpeed and clarity

Why this sample exists

For developer-facing products, the first-run experience matters a lot. A quick-start guide should not try to explain everything. Its job is to help users reach a successful first result quickly, build confidence, and then guide them toward more advanced documentation.

Good quick-start content reduces hesitation. It gives users momentum before they encounter the full complexity of the product.

Target outcome

Use the Fictional Text API to generate a short response in less than five minutes.

Before you begin

  • Create an account in the Fictional Text console.
  • Generate an API key from Settings > API Keys.
  • Install curl or use your preferred HTTP client.

Make your first request

Replace YOUR_API_KEY with your actual key.

curl -X POST https://api.example.dev/v1/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "writer-lite",
    "prompt": "Write a welcome message for a new user.",
    "max_tokens": 80
  }'

Example response

{
  "id": "resp_12345",
  "model": "writer-lite",
  "output": "Welcome! We are glad you're here. Let's get you started.",
  "usage": {
    "input_tokens": 9,
    "output_tokens": 13
  }
}

Design choices

  • Narrow, achievable goal
  • Minimal prerequisites
  • Complete request and response pair
  • Natural path to next-step content

What this demonstrates

  • Audience awareness
  • Onboarding-oriented writing
  • Task-first structure
  • Developer empathy
Fast startUsers can get to a working result quickly.
Low frictionThe sample avoids overload and reduces confusion.
Clear next stepUsers know where to go after first success.