​
Quickstart

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

​
1. Read The Public Index

Start with: 
https://pubfi.ai/discovery
https://pubfi.ai/llms.txt
https://pubfi.ai/llms-full.txt
https://docs.pubfi.ai/reference/agent-interface
Use Discovery to understand source categories, chains, providers, comparison pages, topic pages, and public claim-safe readiness.

​
2. Inspect API And MCP Schemas

Open: 
https://api.pubfi.ai/reference
https://api.pubfi.ai/openapi.json
https://mcp.pubfi.ai/.well-known/mcp.json
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

NeedPath
Compare crypto data providersDiscovery pages
Let an agent inspect available datapubfi.capabilities.search
Turn a data need into a routepubfi.route.plan
Understand why a route was selected or rejectedpubfi.route.explain
Inspect input/output shapepubfi.schema.get
Estimate cost posturepubfi.pricing.quote
Execute a supported routepubfi.route.execute with PubFi API-key auth and planning evidence

​
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 account share account-level credits 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: 
curl --location 'https://api.pubfi.ai/v1/gateway/subscan/polkadot/api/now' \
  --header 'Authorization: Bearer <PubFi API key>'
For provider-specific route examples, including Subscan, DeGov, World Bank, USGS Earthquake, National Weather Service Alerts, Crossref, ROR, DataCite, and Federal Register, read Provider Gateway Examples.

​
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, credits, provider readiness, credential configuration, source freshness evidence, and a supported callable route.

​
Next