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

Poll an enrichment

Returns lifecycle and per-item outcome separately for one enrichment or launch. Another organization's resource is a 404. Free.

GET
/api/v1/enrichments/{enrichmentId}

Returns lifecycle and per-item outcome separately for one enrichment or launch. Another organization's resource is a 404.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

enrichmentId*string

The enrichment to poll

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/enrichments/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "executionId": "fc49a52d-e069-4441-83c6-8d779c937dd9",  "workflow": "string",  "lifecycle": "waiting",  "outcome": "found",  "message": "string",  "input": {    "property1": null,    "property2": null  },  "output": null,  "billing": {    "creditsCharged": 0,    "property1": null,    "property2": null  },  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "launch": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "segmentId": "f2f864fb-5d15-4f35-b9aa-83491924c4db",    "tool": "string",    "executor": "spore",    "launchKind": "validation",    "priority": "background",    "lifecycle": "waiting",    "outcome": "found",    "targeted": 0,    "completed": 0,    "failed": 0,    "canceled": 0,    "cancelRequestedAt": "2019-08-24T14:15:22Z",    "error": {      "code": "string",      "message": "string"    },    "createdAt": "2019-08-24T14:15:22Z"  }}

Run a native enrichment POST

Runs one native tool against an explicit list of the organization's own Company ids. Every tool runs against a Company and reads its Core — name, country, primary Domain, Activity, Identifier — from the target, so a request states only the tool's own settings and, in `context`, the Catalog fields to resolve for each target. A repeated id is one target. A Company this organization does not hold is refused as not found. A target whose Company lacks a Core input the selected tool requires is refused at admission: it appears in `refused` with the slots it could not supply, gets no Run, and costs nothing, while the rest of the launch proceeds. When every target is refused the whole request is refused with `missing_input`. The quote is `runs + unlocks` — research is the door that pays for the Legal entity behind a verified target, one credit, once, forever — and it is refused whole against `maxCredits`. Set `dryRun` for a quote that commits nothing. Variable price, quoted per request.

Follow the organization's durable events stream GET

Redirects to the externally routable workflow engine SSE stream. A client must carry its API key across the redirect, which curl does with --location-trusted and an EventSource cannot do at all, and keeps its Last-Event-ID cursor for resumable delivery. Free.