Download a finished job's values as JSON, CSV or XLSX

GET

/v1/extractions/{jobId}/export

#!/usr/bin/env bash
set -euo pipefail
API=https://api.speccapture.com
AUTH="Authorization: Bearer $SPECCAPTURE_API_KEY"

JOB_ID=7c9e6679-7425-40de-944b-e07fc1f90ae7  # the jobId the submission answered with

curl -sS --fail-with-body "$API/v1/extractions/$JOB_ID/export?format=xlsx" \
  -H "$AUTH" \
  -o extraction.xlsx
curl -sS --fail-with-body "$API/v1/extractions/$JOB_ID/export?format=csv" \
  -H "$AUTH" \
  -o extraction-csv.zip
curl -sS --fail-with-body "$API/v1/extractions/$JOB_ID/export?format=json" \
  -H "$AUTH" \
  -o extraction.json
echo "Saved extraction.xlsx, extraction-csv.zip and extraction.json"

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

HttpResponseMessage xlsxDownload = await Call(HttpMethod.Get, $"/v1/extractions/{jobId}/export?format=xlsx");
await File.WriteAllBytesAsync("extraction.xlsx", await xlsxDownload.Content.ReadAsByteArrayAsync());
HttpResponseMessage csvDownload = await Call(HttpMethod.Get, $"/v1/extractions/{jobId}/export?format=csv");
await File.WriteAllBytesAsync("extraction-csv.zip", await csvDownload.Content.ReadAsByteArrayAsync());
HttpResponseMessage jsonDownload = await Call(HttpMethod.Get, $"/v1/extractions/{jobId}/export?format=json");
await File.WriteAllBytesAsync("extraction.json", await jsonDownload.Content.ReadAsByteArrayAsync());
Console.WriteLine("Saved extraction.xlsx, extraction-csv.zip and extraction.json");

// 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

with open("extraction.xlsx", "wb") as download:
    download.write(call("GET", f"/v1/extractions/{job_id}/export?format=xlsx").content)
with open("extraction-csv.zip", "wb") as download:
    download.write(call("GET", f"/v1/extractions/{job_id}/export?format=csv").content)
with open("extraction.json", "wb") as download:
    download.write(call("GET", f"/v1/extractions/{job_id}/export?format=json").content)
print("Saved extraction.xlsx, extraction-csv.zip and extraction.json")

import { writeFile } from "node:fs/promises";

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

const [jobId] = process.argv.slice(2); // the jobId the submission answered with

const xlsxDownload = await call("GET", `/v1/extractions/${jobId}/export?format=xlsx`);
await writeFile("extraction.xlsx", Buffer.from(await xlsxDownload.arrayBuffer()));
const csvDownload = await call("GET", `/v1/extractions/${jobId}/export?format=csv`);
await writeFile("extraction-csv.zip", Buffer.from(await csvDownload.arrayBuffer()));
const jsonDownload = await call("GET", `/v1/extractions/${jobId}/export?format=json`);
await writeFile("extraction.json", Buffer.from(await jsonDownload.arrayBuffer()));
console.log("Saved extraction.xlsx, extraction-csv.zip and extraction.json");

// 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;
}

Format=json (the job and every sheet exactly as the API returns them), csv (a zip: sheets.csv, one row per sheet, and one file per table type) or xlsx (one workbook). Answers 409 not_finished until every sheet has finished.

Authorizations

ApiKey

Parameters

Path Parameters

jobId

required

string format: uuid

Query Parameters

format

string

Responses

200

string format: binary

400

Bad Request: 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

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

409

Conflict: 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

501

Not Implemented: 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