1. Documentation
  2. Processor
  3. Overview
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

Overview

Send a deal's documents to the Specter processor with your workspace's key, and read back what it found.

Loading documentation…

Drafts, files and corrections< PreviousBest practicesNext >

On this page

Pick the way inHow a job runsThe routes

The processor reads a deal's documents — bank statements, applications, tax returns, credit reports and more — and answers what is still missing, how each bank statement scores for fraud, which lenders fit, and the deal's headline financials.

Pick the way in

You haveUse
Documents arriving by emailSend them to processor@spectersystems.io from your workspace — no key
A server or script holding the filesA processing key and the job routes
Deals already on your Deals pageA Deals key and the deal routes

Every way in files the same job in your workspace, so a document gives the same answer whichever way it came.

A key never goes in a browser

A processing key spends money and reads your deals' documents. Keep it on a server, in an environment variable or a secret manager.

How a job runs

  1. 1

    Declare the files

    POST /v1/api/jobs with each file's name, type and size. The answer carries one upload URL per file.

  2. 2

    Upload the bytes

    PUT each file straight to its URL. The bytes never pass through the API.

  3. 3

    Start it

    POST /v1/api/jobs/{id}/start hands the files to the processor.

  4. 4

    Read the results

    GET /v1/api/jobs/{id} until state is final — then the findings and financials are in the same answer.

The routes

RouteScopeDoes
POST /v1/api/jobsprocessingDeclare a job's files; answers upload URLs
POST /v1/api/jobs/{id}/startprocessingStart processing
GET /v1/api/jobs/{id}readState, files, the job's progress, findings and financials — one call
GET /v1/api/jobsreadThe newest jobs on the key's page, paged

The routes under /v1/ingest/rows/{rowId}/… do the same for a deal that is already on your Deals page — see Process a deal.

Keys, errors and rate limits follow the rules every Specter route shares: Authentication, Errors, Rate limits.