Skip to content
Newsfork Docs

API Quickstart

Use this guide to make your first authenticated API call. For full endpoint details, see v1 API.

Prerequisites

Section titled “Prerequisites”
  • A Newsfork account with an active subscription
  • An API key from your account dashboard or onboarding email

Never share your full API key in support tickets, chat, or public repositories.

Base URL

Section titled “Base URL”

Your integration uses the base URL provided in your account onboarding materials. Contact hello@newsfork.com if you need your production or sandbox base URL.

Authentication

Section titled “Authentication”

Send your API key in the Authorization header:

Terminal window
curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://YOUR_BASE_URL/health"

Replace YOUR_API_KEY and YOUR_BASE_URL with the values from your account.

First requests

Section titled “First requests”

Health check

Section titled “Health check”
Terminal window
curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://YOUR_BASE_URL/health"

List seeds

Section titled “List seeds”
Terminal window
curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://YOUR_BASE_URL/api/v1/seeds"

See Seeds API for query parameters and response fields.

Error handling

Section titled “Error handling”
HTTP statusMeaning
401Missing or invalid API key
403Key valid but not authorized for this resource
429Rate limit exceeded — retry with backoff
5xxServer error — retry with exponential backoff

Rate limits

Section titled “Rate limits”

Rate limits depend on your plan. See Pricing or contact sales for limits on your account.

Next steps

Section titled “Next steps”