PostGrad

Make your first API call

Run your first /v1/knowledge/search request from curl, see the response shape, and learn the three core endpoints.

PostGrad's REST API is three endpoints wide. Once you've got a key, every call follows the same shape: HTTPS, x-api-key header, JSON body, JSON response. This walkthrough takes you from your terminal to a real search result in about three minutes.

Before you start: you need an API key (Get your first API key) and at least one feed you're subscribed to — either the free platform feeds or a paid one from the marketplace.

Open the Quick Start page in your dashboard

The Quick Start page in the PostGrad dashboard, showing a pre-filled curl example and a response preview.
The Quick Start page in the PostGrad dashboard, showing a pre-filled curl example and a response preview.

The command here masks your key for display. When you click Copy, the full key gets written to your clipboard — don't paste it into Slack, a gist, or anywhere you don't control.

Copy the sample curl command

The pre-filled curl sample with the Copy button highlighted.
The pre-filled curl sample with the Copy button highlighted.

Run it in your terminal

The Quick Start page response preview showing a JSON payload with knowledge entries.
The Quick Start page response preview showing a JSON payload with knowledge entries.

If the call returns a 401, your key is wrong or revoked. If it returns a 403, your tier doesn't allow the feature you asked for. If it returns a 429, you've hit your rate limit. See Handle errors gracefully for every code and what to do about it.

Learn the three core endpoints

The API docs page listing the three core endpoints: search, list, stats.
The API docs page listing the three core endpoints: search, list, stats.

You'll use search ninety percent of the time. List is for batch ingestion or building your own secondary index. Stats is for dashboards.

Switch from curl to code

The API docs page showing code snippets for JavaScript, Python, and curl side by side.
The API docs page showing code snippets for JavaScript, Python, and curl side by side.

Watch the call register in Usage

The Usage page showing recent API calls with the new call at the top, its status code, and its latency.
The Usage page showing recent API calls with the new call at the top, its status code, and its latency.

What's next

You've made a call. Now build something real:

On this page