1. Documentation
  2. Processor
  3. Create a key
Open Specter
  • Introduction
  • Quickstart
  • Authentication
  • Errors
  • Rate limits
  • Best practices
  • Overview
  • Access
  • Best practices
  • Create a key
  • Read and write
  • Overview
  • Best practices
  • Hosted page
  • Submit from your code
  • Drafts, files and corrections
  • Overview
  • Best practices
  • Create a key
  • Send documents
  • Read results
  • Findings
  • Process a deal
  • Errors and limits

Create a key

A processing key for your workspace — on its own, or attached to your Deals page.

Loading documentation…

Best practices< PreviousSend documentsNext >

On this page

A key on its ownA key on your Deals pageStore it

A processing key belongs to your workspace. It carries the processing scope — which starts jobs, and so spends money — so only a manager can make one. Add read to read the results back.

A key on its own

For software that sends documents and never needs a deal on a board.

  1. Open Settings → Developer → Workspace API and Issue API key.
  2. Name it after what will use it — "Underwriting sync".
  3. Turn Attach jobs to a board off.
  4. Tick processing and read. A key that isn't attached to a board holds only these two.
  5. Copy the key. It is shown once.

Jobs made with this key land on a page nobody sees in the sidebar; GET /v1/api/jobs/{id} is the whole view of them. A key never switches between attached and not — to change it, make a new one.

Enterprise plan

Keys issued from Settings → Developer → Workspace API need the Enterprise plan; on another plan they answer 402. A key made on the Deals page is never plan-gated.

A key on your Deals page

For software that works on deals your team also sees in Specter. Open the Deals page, then Settings → Developer, and make a key with processing and read — and rows:write to add files to a deal. Its jobs land on Deals as deals, with their files and results. It also opens the deal routes.

Store it

bash
export SPECTER_KEY='sbk_…'

Send it on every request as Authorization: Bearer $SPECTER_KEY (or X-API-Key). A missing, unknown or revoked key answers 401; a key without the scope a route needs answers 403 naming it — this key was not given processing — see Authentication.

A key acts as the person who made it: it reaches what they reach today, and stops reaching anything if they leave the workspace.