API docsTechnical Documentation

API documentation from your endpoint descriptions

Usually ready in 15 minutesRevisions includedQuality check
Packages
Payment protectionDetails
  • Revisions within the package are free.
  • If you do not respond within 3 days of delivery, the work is accepted automatically.

The money is reserved when you pay and released only once you accept the work.

API documentation from your endpoint descriptions

Example result

Example for the Standard package

API documentation: a parcel tracking API for online stores

Quick start

  1. Get your API key in Dashboard → Settings → API keys.
  2. Send every request with the header Authorization: Bearer <your_key>.
  3. Base URL: https://api.trackpoint.example/v1

Get a shipment

GET /shipments/{tracking_number}

Returns the current status and event history of one parcel.

ParameterInRequiredDescription
tracking_numberpathyesCarrier tracking number, 8–30 characters
langquerynoLanguage of status texts: en, de, fr. Default: en

Example request

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

Example response (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

Errors

CodeMeaningWhat to do
401Missing or wrong API keyCheck the Authorization header
404Tracking number not foundCarriers can take up to 2 hours to register a new parcel
429More than 100 requests a minuteWait for the time given in the Retry-After header

Delivered

Docs for all 14 endpoints in Markdown, ready for the client's docs site, and a list of 3 places where the API behaved differently from the descriptions, sent to the developers.

Client: Trackpoint, a startup whose REST API lets online stores show parcel status; the developers sent short descriptions of 14 endpoints and a set of sample requests Task: a quick start and an endpoint reference a developer can follow in 15 minutes; an excerpt is below

The client and all details are made up.

About this service

Developers judge an API by its docs within minutes: if authentication or the first request does not work, they leave. We write API reference and guides from your endpoint descriptions, OpenAPI file or code samples: authentication, base URLs, each endpoint with parameters, request and response examples, error codes, rate limits and pagination. A quick start shows the first successful call in a few steps.

What is included

  • What you getAPI documentation as Markdown with code blocks, ready for ReadMe, GitBook, Docusaurus or your repository. We write from what you send and do not call your API ourselves.
  • Quick startFrom API key to first call
  • Endpoint referenceParameters, types, examples
  • Errors and limitsCodes, meanings, retry advice
  • Code samplescURL plus one language you choose
  • Consistent termsSame names as your schema

How it works

  1. 1
    BriefYou paste or attach endpoints and examples
  2. 2
    Structure and writingWe write the reference and guides
  3. 3
    DeliveryYou get Markdown ready to publish

What we need from you

Endpoint descriptions or an OpenAPI or Postman file pasted as text, authentication details, example requests and responses, error codes and who your API users are.

We will ask you:

  • What does the API do, and who uses it?
  • How does authentication work?
  • Which language should the code samples use besides cURL?
  • Where will the docs be published?

Compare packages

PackagesBasic$19Standard$39Premium$79
What is includedQuick start and up to 5 endpointsUp to 20 endpoints with guidesUp to 50 endpoints, full docs
Deadline1 day3 days5 days
Revisions123
Lengthup to 2,000 wordsup to 6,000 wordsup to 14,000 words
Endpointsup to 5up to 20up to 50
Code sample languagescURLcURL + 1cURL + 2
Order BasicOrder StandardOrder Premium

Payment protection

You pay when you order, but the money is released only for accepted work.

  • Fixed priceThe package price does not change after you pay.
  • The money is reservedWhen you pay, the amount is only reserved. It is released to the service once you accept the work.
  • Checked before deliveryEvery result goes through a quality check before it reaches you, and you see it on the order page before accepting it.
  • Free revisionsAsk for changes within your brief as many times as the package allows.
  • Acceptance after 3 daysIf within 3 days of delivery you neither accept the work nor ask for changes, it is accepted automatically. If you write in the order chat after delivery, the order waits; once we answer, we may start the 3 days again and will say so in the chat.
  • Redo or a full refundIf the result does not match your brief and the revisions did not fix it, or the work takes more than twice its deadline, write in the order chat: we will redo the work or refund the payment in full.
How it works →

Questions and answers

Can you work from our OpenAPI spec?

Yes, paste the YAML or JSON into the brief. We turn its descriptions into readable reference pages and fill gaps you point out.

Will you test the examples?

We do not call your API. Examples are built from your request and response samples, so run them once before publishing.

Do you write SDK docs?

Yes, if you send the method signatures and usage examples. Count each SDK as part of the package volume.

Did not find your answer?

Packages