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

Create an API key and reveal its secret once

Requires an explicitly delegated key:manage capability whose creator is still an organization owner or admin. Callers carrying any spend bounds cannot create keys: delegation must not multiply a rolling budget. An unbounded management key may grant requested scopes, including priced scopes with finite per-request and rolling-budget bounds. Child expiry cannot exceed the caller's expiry. A restricted caller must grant an explicit subset of its Operation allowlist and cannot delegate key:manage. Null allowedOperations permits every Operation allowed by scopes; [] permits none. The secret is returned only on initial success and is never persisted in the idempotency receipt. Replays return 409; revoke the created key and use a new request if the secret was lost. Free.

POST
/api/v1/keys

Requires an explicitly delegated key:manage capability whose creator is still an organization owner or admin. Callers carrying any spend bounds cannot create keys: delegation must not multiply a rolling budget. An unbounded management key may grant requested scopes, including priced scopes with finite per-request and rolling-budget bounds. Child expiry cannot exceed the caller's expiry. A restricted caller must grant an explicit subset of its Operation allowlist and cannot delegate key:manage. Null allowedOperations permits every Operation allowed by scopes; [] permits none. The secret is returned only on initial success and is never persisted in the idempotency receipt. Replays return 409; revoke the created key and use a new request if the secret was lost.

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/keys" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "Research agent",    "scopes": [      "search:run"    ],    "expirationDays": 1,    "budgetCredits": 100,    "budgetPeriodDays": 1,    "maxRequestCredits": 10,    "allowedOperations": [      "search"    ]  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "key": "string",  "keyPrefix": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "scopes": [    "commons:publish"  ],  "allowedOperations": [    "audit-calls"  ],  "budgetCredits": 0,  "budgetPeriodDays": -9007199254740991,  "maxRequestCredits": 0}

Page a Job's frozen target list GET

The ordered Companies this Job was admitted over, with the watermarks it was computed under: the admission transaction's own time, and the Commons Generation this Job read for each Jurisdiction the Commons served. The list is frozen at admission: deleting a target, merging it into another Company, or changing the Segment that selected it never rewrites the receipt, so a target id here may no longer name a live Company. Free.

Revoke an organization API key POST

Requires key:manage and a creator who is still an organization owner or admin. The target must belong to the authenticated organization; missing and foreign keys both return 404. Revoking a recorded parent or transitive ancestor returns 403 key_ancestor_revocation_forbidden, including through revoked ancestors. Revoking an already revoked non-ancestor key succeeds without another policy event. Subsequent authentication with the revoked key is refused. Free.

name*string
Length1 <= length <= 100
scopes*array<>
Items1 <= items
expirationDays*integer
Range1 <= value <= 360
budgetCredits?integer
Range0 <= value <= 9007199254740991
budgetPeriodDays?integer
Range1 <= value <= 365
maxRequestCredits?integer
Range0 <= value <= 9007199254740991
allowedOperations?array<>|null