Quickstart

This quickstart shows how to orient around PubFi’s public docs, Discovery surfaces, and agent interfaces.

1. Read The Public Index

Start with:
Use Discovery to understand source categories, chains, providers, comparison pages, topic pages, and public claim-safe readiness.

2. Inspect API And MCP Schemas

Open:
The API reference is the interactive HTTP reference. The OpenAPI schema is the machine-readable HTTP contract source. The MCP manifest is the agent-tool discovery surface.

3. Choose The Right Path

4. Create Or Load An API Key

Open the PubFi dashboard, go to Manage application keys, and create a key for the environment or agent runtime you are wiring up. Name keys by where they run, such as staging, production, or agent-runtime. Copy the key when it is shown. PubFi keys use the pf_sk_v1_ prefix and are shown only once after creation. Multiple keys under the same billing account share its request allowance and usage history.

5. Keep Secrets Out Of Prompts

PubFi API keys belong in a secret store or environment variable. Upstream provider keys stay server-side and must not be sent by agents.

6. Send A Minimal Gateway Request

Use a public route-shape example when you need to confirm gateway auth and endpoint routing:
For provider-specific Subscan and DeGov route-shape examples, read Provider Gateway Examples. Check the current public gateway catalog and readiness evidence before treating any example as callable.

7. Check Readiness Before Execution

Do not treat a source page, schema, or route plan as proof of live execution. Live execution also requires PubFi API-key auth, fresh active billing admission, sufficient request allocation, provider readiness, credential configuration, source freshness evidence, and a supported callable route.

Next