API Reference

API Reference

Every console surface is a plain HTTP endpoint returning JSON. Base URL is your deployment host โ€” locally http://127.0.0.1:8017.

Endpoints marked ๐Ÿ”’ require an API key. Public endpoints need none. All request and response bodies are JSON.

Authentication

Pass your key in the X-API-Key request header. Manage keys in the Console.

curl "http://127.0.0.1:8017/v2/subnets" \
  -H "X-API-Key: $BTI_API_KEY"

Runtime & messages

Health, source metadata and normalized message access.

GET/healthLiveness probe
GET/statusRuntime status & versions
GET/sourcesList ingest sources
GET/sources/metaSource metadata
GET/messagesQuery normalized messages ๐Ÿ”’
GET/messages/metaMessage facets & counts ๐Ÿ”’
GET/messages/qualityMessage quality metrics ๐Ÿ”’

Subnets (v2)

Object-first subnet intelligence. All routes require a key.

GET/v2/subnetsList all subnets ๐Ÿ”’
GET/v2/subnets/{netuid}Subnet profile ๐Ÿ”’
GET/v2/subnets/{netuid}/contextFull context object ๐Ÿ”’
GET/v2/subnets/{netuid}/timelineChronological events ๐Ÿ”’
GET/v2/subnets/{netuid}/claimsExtracted claims ๐Ÿ”’
GET/v2/subnets/{netuid}/evidenceSupporting evidence ๐Ÿ”’
GET/v2/subnets/{netuid}/reportComposed report ๐Ÿ”’
GET/v2/entities/{entity_id}/neighborhoodEntity graph ๐Ÿ”’

Memory

Cross-message facts, people, events and claims over the corpus.

GET/memory/searchSearch the corpus ๐Ÿ”’
GET/memory/researchResearch-grade retrieval ๐Ÿ”’
GET/memory/claimsClaim records ๐Ÿ”’
GET/memory/manifestMemory manifest ๐Ÿ”’
GET/memory/person/{entity_id}Person record ๐Ÿ”’
GET/memory/subnet/{subnet}Subnet memory ๐Ÿ”’
GET/memory/event/{event_id}Event record ๐Ÿ”’
GET/memory/fact/{fact_id}Fact record ๐Ÿ”’

Insights

Aggregate statistics, topics and trends.

GET/insights/statsCorpus statistics ๐Ÿ”’
GET/insights/searchSearch insights ๐Ÿ”’
GET/insights/topicsTrending topics ๐Ÿ”’
GET/insights/trendsTime-series trends ๐Ÿ”’
GET/insights/listList insights ๐Ÿ”’

Knowledge

Static and generated knowledge documents.

GET/knowledge/static/documentsList static docs ๐Ÿ”’
GET/knowledge/static/searchSearch static docs ๐Ÿ”’
GET/knowledge/static/documentFetch a static doc ๐Ÿ”’
GET/knowledge/created/documentsList generated docs ๐Ÿ”’
GET/knowledge/created/searchSearch generated docs ๐Ÿ”’

Research & datasets

Datasets, metrics, repositories and media intelligence. All routes require a key.

GET/data/catalogDataset catalog ๐Ÿ”’
GET/datasets/subnets/latestLatest subnet dataset ๐Ÿ”’
GET/datasets/subnets/reviewReview queue ๐Ÿ”’
POST/datasets/subnets/review/{netuid}/overrides/materializeApply overrides ๐Ÿ”’
GET/metrics/subnets/{netuid}Subnet metrics ๐Ÿ”’
GET/profiles/subnets/{netuid}Subnet profile ๐Ÿ”’
GET/repos/discoverDiscover repositories ๐Ÿ”’
GET/repos/subnets/{netuid}Repos for a subnet ๐Ÿ”’
GET/media/search/revenueRevenue-claim media ๐Ÿ”’
GET/media/claimsMedia claims ๐Ÿ”’
GET/signals/socialSocial signals ๐Ÿ”’
GET/pipelinesPipeline definitions ๐Ÿ”’
GET/pipelines/runsPipeline run history ๐Ÿ”’

Assistant

Conversational intelligence over the corpus.

POST/assistant/chatChat completion ๐Ÿ”’
# Request body
{ "message": "What changed on subnet 64 this week?" }

Twitter

Managed Twitter/X account access.

GET/twitter/accountsList accounts ๐Ÿ”’
POST/twitter/accounts/addAdd an account ๐Ÿ”’
POST/twitter/accounts/{profile}/removeRemove an account ๐Ÿ”’
GET/twitter/followingFollowing list ๐Ÿ”’

Streaming

Live event stream over Server-Sent Events.

GET/eventsSSE event stream ๐Ÿ”’

Ops & billing

Operational health and spend. Health & summary are public.

GET/ops/healthOps health
GET/ops/service-qualityLive service quality
GET/ops/alertsActive alerts
GET/ops/work-queuesWork queue depth
GET/ops/worker/planWorker schedule
GET/ops/spend/summarySpend summary
POST/ops/spend/checkPre-flight spend check ๐Ÿ”’
POST/ops/spend/recordRecord spend ๐Ÿ”’

Account & keys

Session, account and API-key management.

POST/auth/loginLog in
POST/auth/demoStart a demo session
GET/auth/demo-credentialsDemo credentials
GET/auth/meCurrent account ๐Ÿ”’
POST/auth/logoutLog out ๐Ÿ”’
GET/auth/api-keysList API keys ๐Ÿ”’
POST/auth/api-keysCreate an API key ๐Ÿ”’
DELETE/auth/api-keys/{key_id}Revoke an API key ๐Ÿ”’
GET/auth/billingBilling details ๐Ÿ”’
Prefer to explore interactively? Open the Playground โ†’ or read the Guide โ†’