Send your first request

This guide demonstrates a complete create → read → delete loop against the example API. Follow it end-to-end, then swap the URLs and resource for whatever your own product exposes.

Note

A how-to guide assumes the reader already knows the basics. If you’re new, start with Quickstart first.

Steps

1. Create a widget.

   curl

   curl https://api.example.com/v1/widgets \
     -H "Authorization: Bearer $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"name": "Demo widget"}'

   JavaScript

   const widget = await fetch('https://api.example.com/v1/widgets', {
     method: 'POST',
     headers: {
       Authorization: `Bearer ${process.env.API_KEY}`,
       'Content-Type': 'application/json',
     },
     body: JSON.stringify({ name: 'Demo widget' }),
   }).then((r) => r.json());

   Save the returned id — you’ll use it in the next step.

2. Read it back.

   curl

   curl https://api.example.com/v1/widgets/$WIDGET_ID \
     -H "Authorization: Bearer $API_KEY"

   JavaScript

   const widget = await fetch(
     `https://api.example.com/v1/widgets/${id}`,
     { headers: { Authorization: `Bearer ${process.env.API_KEY}` } },
   ).then((r) => r.json());

3. Clean up.

   curl -X DELETE https://api.example.com/v1/widgets/$WIDGET_ID \
     -H "Authorization: Bearer $API_KEY"

Further reading

• API reference — every endpoint and field.
• Errors — what each error code means.
• Read about how-to guides in the Diátaxis framework.