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

Publish a staged Commons Generation

Requires a platform-scoped commons:publish key; organization keys are refused regardless of scopes. The Service validates the staged Generation and atomically publishes its data aliases and Directory. A gate refusal changes no aliases. Free.

POST
/api/v1/commons/publish

Requires a platform-scoped commons:publish key; organization keys are refused regardless of scopes. The Service validates the staged Generation and atomically publishes its data aliases and Directory. A gate refusal changes no aliases.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Required for writes. Reusing this key with the same input replays the original response.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/commons/publish" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "jurisdiction": "string",    "generation": "string",    "indices": {      "property1": "string",      "property2": "string"    },    "counts": {      "property1": 0,      "property2": 0    },    "schemes": [      {        "jurisdiction": "string",        "scheme": "string",        "displayName": "string",        "issuingAuthority": "string",        "normalization": "strip-whitespace-punctuation-uppercase",        "registryIdentifier": true,        "firstGeneration": "string"      }    ]  }'
{  "id": "string",  "kind": "generation",  "schemaVersion": "0.3.0",  "jurisdiction": "string",  "generation": "string",  "publishedAt": "string",  "indices": {    "property1": "string",    "property2": "string"  }}

Read a vocabulary: tools, filters, knowledge, or NACE GET

One discovery endpoint over four vocabularies, selected by `section`. `tools` lists available workflows, `filters` describes the search grammar, `knowledge` reports this organization's declared namespaces, and `nace` returns the NACE Rev 2.1 taxonomy. NACE also supports a compact text projection and a flat Class-level projection. Free.

Restore the retained previous Commons Generation POST

Requires a platform-scoped commons:publish key; organization keys are refused regardless of scopes. Publishes the retained previous Generation for this Jurisdiction. Send a fresh Idempotency-Key for each intentional rollback, and reuse it only to retry that rollback. Free.

jurisdiction*string
Match^[A-Z]{2}$
generation*string
Match^\d{8}_\d{6}$
schemaVersion?string
Default"0.3.0"
indices*
counts*
schemes*array<>