Skip to main content

1. Introduction to API Documentation

Tier: All Tiers | Part: Foundation

What Is API Documentation?​

API documentation explains how to use an Application Programming Interface. It tells developers what the API can do, how to authenticate, what requests to send, what responses to expect, and how to handle errors.

Why It Matters in 2026​

  • Companies with excellent docs see up to 50% fewer support tickets
  • Freelance API writers earn $75–$150/hour
  • Developer experience (DX) is now a competitive advantage

Five Types of API Documentation​

TypePurpose
Reference DocsEvery endpoint, parameter, and response
Getting StartedOnboard developers in minutes
How-To GuidesAccomplish specific tasks
Conceptual DocsArchitecture and key concepts
TutorialsStep-by-step walkthroughs

NotiFlow Context​

Base URL: https://api.notiflow.io/v1

Core Endpoints:

  • POST /messages — Send a message
  • GET /messages/{id} — Retrieve a message
  • DELETE /messages/{id} — Delete a message
  • GET /threads — List message threads
  • POST /webhooks — Register a webhook

Checklist​

  • I understand what API documentation is
  • I know the five types of API documentation
  • I understand my role as a technical writer
  • I am familiar with NotiFlow and its core endpoints