Download a job's result

GET

/v1/jobs/{id}/result

curl -H "X-Api-Key: $KEY" \
  "http://localhost:9027/v1/jobs/$JOB/result" -o invoice.pdf

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

const response = await fetch(`http://localhost:9027/v1/jobs/${process.env.JOB}/result`, {
  headers: { 'X-Api-Key': process.env.KEY },
});
if (!response.ok) throw new Error(await response.text());
await writeFile('invoice.pdf', Buffer.from(await response.arrayBuffer()));

import os
from pathlib import Path

import requests

response = requests.get(
    f"http://localhost:9027/v1/jobs/{os.environ['JOB']}/result",
    headers={"X-Api-Key": os.environ["KEY"]},
)
response.raise_for_status()
Path("invoice.pdf").write_bytes(response.content)

package main

import (
  "io"
  "log"
  "net/http"
  "os"
)

func main() {
  url := "http://localhost:9027/v1/jobs/" + os.Getenv("JOB") + "/result"
  request, err := http.NewRequest("GET", url, nil)
  if err != nil {
    log.Fatal(err)
  }
  request.Header.Set("X-Api-Key", os.Getenv("KEY"))

  response, err := http.DefaultClient.Do(request)
  if err != nil {
    log.Fatal(err)
  }
  defer response.Body.Close()
  if response.StatusCode >= 300 {
    message, _ := io.ReadAll(response.Body)
    log.Fatalf("%s: %s", response.Status, message)
  }

  out, err := os.Create("invoice.pdf")
  if err != nil {
    log.Fatal(err)
  }
  defer out.Close()
  if _, err := io.Copy(out, response.Body); err != nil {
    log.Fatal(err)
  }
}

Downloads what a finished job made, as the request would have answered it.

Authorizations

api_key
bearer
basic

Parameters

Path Parameters

required

string

The job’s id

Responses

200

The file

application/octet-stream

The file, as bytes.

string format: binary

404

This caller has no such job, or it expired

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

409

The job has not finished, or it failed

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

501

RUSTICDOC_STORE is not set

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

503

The store cannot be reached

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}