Documentation
Documentation

Overview

Spore docs

Start here

Getting startedInstall the CLIAuthentication and keys

Build

Search and filtersSegments and the loopEnrichment lifecycle

Recipes

Recipe: search to a live SegmentRecipe: enrich without a segmentRecipe: land your own research

Connect

Events

Account

Credits and billing

Reference

Conventions
API reference
Export the organization's Operation calls POSTPage the organization's Operation calls GETExport the organization's recorded acts POSTPage the organization's recorded acts GETCancel an enrichment launch POSTRead a vocabulary: tools, filters, knowledge, or NACE GETPublish a staged Commons Generation POSTRestore the retained previous Commons Generation POSTPage the organization's Companies GETCorrect a Company's Core under Spore-If-Match PATCHDelete a Company DELETERead everything you know about one Company GETRead Legal entity data for Companies you hold POSTFind Legal entities in the Commons POSTFold one Company into another POSTMint Companies from your own data, or attach rows to Companies you hold POSTPromote a declared current Fact into Company Core POSTRead one Company GETMeasure requested fields over a set of Companies POSTRun a native enrichment POSTPoll an enrichment GETFollow the organization's durable events stream GETPage a Job's frozen target list GETCreate an API key and reveal its secret once POSTRevoke an organization API key POSTList per-item enrichment outcomes GETDeclare a namespace and its fields before recording into them POSTDelete a declaration while nothing stands on it DELETERead your Catalog GETRecord what you observed about a Company or concluded about a Segment POSTUnlock every Legal entity a search matched POSTSearch the Commons: count, analytics, and a minted sample POSTPage a Segment's members, with the exact count GETName a live filter over your Companies POSTDelete a Segment DELETERead what you have concluded about one Segment GETRename a Segment, or change what it means, under Spore-If-Match PATCHRead a Segment's name and filter GETPage the organization's Segments GETPage the organization's credit ledger GETRead the balance and this key's spend bounds GET

API reference

Every public Spore operation, generated from the contract registry the server itself validates against.

Each operation page under this folder is generated from /api/v1/openapi.json, which is in turn projected from the contract registry against which the routes validate. This index page is authored; the generated reference pages cannot describe an endpoint the server does not serve, a field the schema does not accept, or a price the ledger does not charge.

Each operation page carries its schemas, its documented error statuses, its price in prose, and a try-it playground. The playground posts to the real /api/v1 route on this origin — it spends your credits, with your key.

  • Base URL — https://www.spore.ee
  • Auth — Authorization: Bearer spore_sk_... on every request. See Authentication and keys.
  • Errors — a JSON body with error and message; spend refusals add the bound and the quoted cost. See Credits and billing.
  • Whole surface in one file — the agent guide lists every operation, its scope, its price and its documented refusals, rendered from the same registry. The api role serves the identical file at /api/v1/llms.txt.

New to the API? Start with Getting started, then Search and filters.

Conventions

The envelope, lifecycle, outcomes, rate limit, cursors, ETags, idempotency, and the async pattern — everything that is true of every operation.

Export the organization's Operation calls POST

Export selected calls, a key-filtered query, or the organization call Collection using explicit allowlisted fields. Small exports return inline bytes; larger exports return a durable artifact receipt. Free.