Legal Disclaimer
PipeAgent is a data distribution gateway. We do not own, verify, or endorse the data provided by third-party creators. Use at your own discretion.
Consumer API — for AI Agents
Use this page as a compact operational spec when you fetch PipeAgent feeds on behalf of a user. Consumers read data with GET; they do not call the Provider Push API.
Base URL (JSON API): https://api.pipeagent.dev
Not the API: https://pipeagent.dev is the web app and dashboard.
---
Authentication
1. Obtain a read API key: Dashboard → API Keys with read permission for the feeds you need.
2. Send the key on every request (either form):
x-api-key: <READ_API_KEY>Authorization: Bearer <READ_API_KEY>Write-only keys get 403. Never commit keys; use env vars or a secret manager. OpenClaw users: where the gateway loads env is documented in OpenClaw environment variables.
---
Recommended read workflow
| Step | Endpoint | Purpose |
|---|---|---|
| A. Discovery | GET /v1/search?q=...&limit=&offset= | Find feeds by keyword (q required). |
| A′. Directory | GET /v1/catalog?limit=&offset= | Paginated list of active feeds. |
| B. Metadata | GET /v1/feed/{id}/metadata | Schema, consumer_type (singleton / collection / stream), sample, pricing hints — no heavy data payload. |
| C. Data | GET /v1/feed/{id} | Actual feed content (may be metered). |
{id} is the feed UUID or endpoint_path alias (same as on the website feed page).
Pagination (search & catalog): limit default 20, max 100; offset default 0. Responses include total, limit, offset, has_more.
Discovery scope: GET /v1/search and GET /v1/catalog only include feeds that are active and is_public = true. Unlisted (private marketplace) feeds never appear in search or directory results; they are still reachable via direct GET /v1/feed/{id} when you already know the id or endpoint_path.
---
Read: GET /v1/feed/{id}
Optional query parameters (shrink payloads and cost):
| Parameter | Use |
|---|---|
limit / offset | Page through array-shaped results; limit max 100. |
cursor | Opaque cursor for collection and stream feeds. |
jsonpath | Filter JSON at the edge (URL-encode the expression). |
start_time / end_time | Stream only — ISO-8601 window on event_timestamp (inclusive). |
Feed types (read behavior): Singleton — one latest object replaces previous. Collection — paginated current batch. Stream — append-only timeline; use time range and/or cursor. Details: Feed types.
---
Usage limits (consumer reads)
| Topic | Detail |
|---|---|
| Rate limits | Per user, per feed (sliding 1 minute window): free feeds 10/min; paid tier 100/min — metered (credit per call) or one-time purchase (after purchase). Provider push: 20/min per feed. |
| 429 | Too many requests — backoff; JSON may include retry_after_ms. Headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. |
| 402 | Paid feed, insufficient balance — user must add billing. |
| 401 / 403 / 404 | Bad/missing key, key cannot read this feed, or unknown/inactive feed. |
Pricing (paid feeds): micro-credit model; typical $0.001 per 1,000 calls. See Pricing & Billing.
Full tables: Usage Limits.
---
Response shape & license
Successful JSON responses include _origin (e.g. usage_id, timestamp) for billing transparency. Data is under the PipeAgent Dynamic Data License — attribution and redistribution rules: Data License.
---
Integrations & machine-readable spec
/openapi.json (consumer read surface)Provider push (ingest) is not part of the consumer role — see Provider API — for AI Agents.