Get one sheet's extracted values

GET

/v1/extractions/{jobId}/sheets/{sheetNumber}

JOB_ID=7c9e6679-7425-40de-944b-e07fc1f90ae7  # the jobId the submission answered with
SHEET_NUMBER=1  # which sheet: 1 is the first page

curl -sS "https://api.speccapture.com/v1/extractions/$JOB_ID/sheets/$SHEET_NUMBER" \
  -H "Authorization: Bearer $SPECCAPTURE_API_KEY"

using System.Text.Json;

using HttpClient http = new() { BaseAddress = new Uri("https://api.speccapture.com") };
http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("SPECCAPTURE_API_KEY"));

string jobId = args[0]; // the jobId the submission answered with
string sheetNumber = args[1]; // which sheet: 1 is the first page

HttpResponseMessage response = await Call(HttpMethod.Get, $"/v1/extractions/{jobId}/sheets/{sheetNumber}");
Console.WriteLine(await response.Content.ReadAsStringAsync());

// Sends a request; stops with the problem's code and detail if the API refuses it.
async Task<HttpResponseMessage> Call(HttpMethod method, string path, HttpContent? body = null, string? idempotencyKey = null) {
    using HttpRequestMessage request = new(method, path) { Content = body };
    if (idempotencyKey is not null) request.Headers.Add("Idempotency-Key", idempotencyKey);
    HttpResponseMessage response = await http.SendAsync(request);
    if (!response.IsSuccessStatusCode) {
        JsonElement problem = await Json(response);
        string? detail = (problem.TryGetProperty("detail", out JsonElement text) ? text : problem.GetProperty("title")).GetString();
        Console.Error.WriteLine($"{(int)response.StatusCode} {problem.GetProperty("code")}: {detail}");
        Environment.Exit(1);
    }
    return response;
}

// Reads an answer as JSON.
static async Task<JsonElement> Json(HttpResponseMessage response) =>
    JsonDocument.Parse(await response.Content.ReadAsStringAsync()).RootElement;

import os
import sys

import requests

API = "https://api.speccapture.com"
session = requests.Session()
session.headers["Authorization"] = f"Bearer {os.environ['SPECCAPTURE_API_KEY']}"


def call(method, path, **kwargs):
    """Send a request; stop with the problem's code and detail if the API refuses it."""
    response = session.request(method, API + path, **kwargs)
    if not response.ok:
        problem = response.json()
        sys.exit(f"{response.status_code} {problem['code']}: {problem.get('detail', problem['title'])}")
    return response


job_id = sys.argv[1]  # the jobId the submission answered with
sheet_number = sys.argv[2]  # which sheet: 1 is the first page

print(call("GET", f"/v1/extractions/{job_id}/sheets/{sheet_number}").text)

const API = "https://api.speccapture.com";
const headers = { Authorization: `Bearer ${process.env.SPECCAPTURE_API_KEY}` };

const [jobId, sheetNumber] = process.argv.slice(2); // the jobId the submission answered with; which sheet: 1 is the first page

console.log(await call("GET", `/v1/extractions/${jobId}/sheets/${sheetNumber}`).then((response) => response.text()));

// Sends a request; stops with the problem's code and detail if the API refuses it.
async function call(method, path, init = {}) {
  const response = await fetch(API + path, { ...init, method, headers: { ...headers, ...init.headers } });
  if (!response.ok) {
    const problem = await response.json();
    console.error(`${response.status} ${problem.code}: ${problem.detail ?? problem.title}`);
    process.exit(1);
  }
  return response;
}

Each value has its path, value (a reviewer’s correction when there is one), extractedValue (what was read), confidence, reviewState, reviewReasons and box. confidence is how sure SpecCapture is of extractedValue, from 0 to 1; it is null for a general note, which is not scored, and for a value whose reviewState is corrected: that value is a person’s, and needs no threshold. A sheet not read yet answers with its status and no values.

Authorizations

ApiKey

Parameters

Path Parameters

jobId

required

string format: uuid

sheetNumber

required

integer format: int32

/^-?(?:0|[1-9]\d*)$/

Responses

200

application/json

object

jobId

required

string format: uuid

sheetNumber

required

integer format: int32

status

required

Allowed values: queued running completed failed

reviewState

required

One of:

null
unknown

null

engineVersion

required

null | string

completedAt

required

null | string format: date-time

fields

required

Array<object>

object

path

required

string

value

required

null | string

extractedValue

required

null | string

confidence

required

null | number format: double

reviewState

required

Allowed values: autoAccepted needsReview accepted corrected

reviewReasons

required

Array<string>

box

required

One of:

null
object

null

name

null | string

tables

required

Array<object>

object

path

required

string

rows

required

Array<object>

object

rowIndex

required

integer format: int32

cells

required

object

key

additional properties

object

path

required

string

value

required

null | string

extractedValue

required

null | string

confidence

required

null | number format: double

reviewState

required

Allowed values: autoAccepted needsReview accepted corrected

reviewReasons

required

Array<string>

box

required

One of:

null
object

null

name

null | string

name

null | string

testMode

required

boolean

markedControlled

boolean

controlledMarking

null | string

drawingPurgedAt

null | string format: date-time

controlledKept

One of:

null
object

null

404

Not Found: a problem with a stable code. See Errors for every code and what to do about it.

application/problem+json

Every error: a problem with a stable code. https://speccapture.com/docs/api/errors lists every code.

object

type

A link to the code’s entry in the docs.

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

code

What went wrong, as a stable code to branch on: a published code never changes meaning.

string

traceId

This request’s trace: quote it when asking for help.

string