API Quick Start

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.

What the document looks like

The preview above mirrors the structure of the sample itself, including the one-goal onboarding path, setup checklist, request example, and success response. I used a screenshot-style layout so hiring teams can quickly understand the shape of the document before reading the full page.

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
  }
}

What comes after the quick start

Once users complete their first request, the documentation should naturally lead them toward more advanced use cases.

Try a more complex prompt

curl -X POST https://api.example.dev/v1/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "writer-pro",
    "prompt": "Write a product description for a wireless headphone with 30-hour battery life, active noise cancellation, and a lightweight design. Target audience: remote workers and frequent travelers.",
    "max_tokens": 200,
    "temperature": 0.7,
    "style": "professional"
  }'

Response with richer output

{
  "id": "resp_67890",
  "model": "writer-pro",
  "output": "Experience all-day comfort with our lightweight wireless headphones featuring 30-hour battery life. Perfect for remote workers and frequent travelers, our advanced active noise cancellation blocks out distractions so you can focus on what matters. Whether you're on a cross-country flight or in a busy home office, enjoy crystal-clear audio with premium sound quality. The ergonomic design ensures comfort even during extended wear.",
  "usage": {
    "input_tokens": 45,
    "output_tokens": 89
  }
}

Quick API reference snippet