1. Documentation
  2. Processor
  3. Process a deal
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

Process a deal

Add files to a deal already on your Deals page, process it, and read the results — by row id.

Loading documentation…

Findings< PreviousErrors and limitsNext >

On this page

Add a fileProcess itRead it

With a key made on your Deals page, the same processing works on a deal that already exists, addressed by its row id. Use these when your team also works the deal in Specter.

RouteScopeDoes
GET /v1/ingest/rows/{rowId}/filesreadThe deal's files
POST /v1/ingest/rows/{rowId}/filesrows:writeDeclare a file; answers its upload URL
POST /v1/ingest/rows/{rowId}/processprocessingProcess the deal's documents
GET /v1/ingest/rows/{rowId}/processingreadThe latest job, its steps and its documents
GET /v1/ingest/rows/{rowId}/findingsreadThe latest job's findings
GET /v1/ingest/rows/{rowId}/financialsreadThe deal's headline financials

A deal's row id comes from reading the page, or from the answer when you add the deal with the same key.

Add a file

bash
curl -X POST https://neo-app-api-prod-836053680024.us-central1.run.app/v1/ingest/rows/$ROW_ID/files \  -H "Authorization: Bearer $SPECTER_KEY" \  -H "Content-Type: application/json" \  -d '{"name": "april.pdf", "contentType": "application/pdf", "sizeBytes": 471902, "documentType": "bank_statement"}'

A 201 answers the file in data and uploadUrl beside it. Upload the bytes exactly as for a job — a PUT with the declared Content-Type, within 15 minutes (Upload each file).

Process it

bash
curl -X POST https://neo-app-api-prod-836053680024.us-central1.run.app/v1/ingest/rows/$ROW_ID/process \  -H "Authorization: Bearer $SPECTER_KEY"

It processes every file on the deal, and answers like starting a job: 201 a new job, 200 the job these files already started, 409 would_supersede with the fields a re-run would replace (send {"replace": true} to go ahead). The optional body takes idempotencyKey and replace.

Read it

GET …/processing answers the job — status, events, documents with their extractions — the same job object as Read results. A deal never processed answers an empty job, not a 404. GET …/findings and GET …/financials answer the findings and financials on their own.

These routes share the board routes' limit of 120 requests a minute per key — see Rate limits.