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

Delete a declaration while nothing stands on it

Deletes one field with `?field=`, or the whole namespace without it. A field a Fact references is refused naming it: the declaration is what makes a recorded value readable, so it outlives nothing. Removing a namespace's last field removes the namespace. A native namespace is never deletable. Free.

DELETE
/api/v1/namespaces/{namespaceName}

Deletes one field with ?field=, or the whole namespace without it. A field a Fact references is refused naming it: the declaration is what makes a recorded value readable, so it outlives nothing. Removing a namespace's last field removes the namespace. A native namespace is never deletable.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

namespaceName*string

The namespace's name.

Query Parameters

field?string

Delete just this field instead of the whole namespace.

Header Parameters

Idempotency-Key*string

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/namespaces/string" \  -H "Idempotency-Key: string"
{  "name": "icp",  "deleted": true,  "fields": [    "score"  ]}

Declare a namespace and its fields before recording into them POST

Declares what your organization wants to know about Companies: a namespace with typed fields, each carrying its unit, dimension, freshness, and meaning. Recording into a field that is not declared is refused, so this call comes first. The same call amends: a field you already declared is left alone, a new one is added, and a description or freshness you changed your mind about is updated — which makes it safe to send your whole catalog on every boot. What it never does is remove a field by omission, or change what a field *is* once a Fact references it: name, type, unit, dimension, and promotion are then fixed and the fix for a mistake is a new field. Caps are 1000 namespaces and 50 fields each. Free.

Read your Catalog GET

Returns every namespace this organization can record into: its own declarations, and the native ones the Spore tools own. A field marked `frozen` has Facts standing on it, so its type, unit, dimension, and promotion are fixed. The Catalog is private to the organization and never shared-cached. Free.