Get a job

GET

/v1/jobs/{id}

curl -H "X-Api-Key: $KEY" "http://localhost:9027/v1/jobs/$JOB"

const response = await fetch(`http://localhost:9027/v1/jobs/${process.env.JOB}`, {
  headers: { 'X-Api-Key': process.env.KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

import os

import requests

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

package main

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

func main() {
  url := "http://localhost:9027/v1/jobs/" + os.Getenv("JOB")
  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)
  }
  if _, err := io.Copy(os.Stdout, response.Body); err != nil {
    log.Fatal(err)
  }
}

Where a background job is. Ask again until status is done or failed; Retry-After says how soon. A job and its result are kept for RUSTICDOC_JOB_TTL after it ends, then removed.

Authorizations

api_key
bearer
basic

Parameters

Path Parameters

required

string

The job’s id, from the 202’s body or Location

Responses

200

The job

application/json

A background job.

object

createdAt

required

RFC 3339, to the millisecond.

string

error

Present once it failed: what the request would have answered, as error, message and status.

object | null

expiresAt

When the job and its result are removed.

string | null

finishedAt

string | null

required

string

requestId

required

The X-Request-Id of the request that started it.

string

result

One of:

object
null

Present once it is done; download it from /v1/jobs/{id}/result.

object

contentType

required

string

name

required

string

sha256

required

Hex SHA-256 of the content.

string

size

required

integer format: int64

runsUntil

required

A job that has not ended by then is reported as failed with job_lost: the container running it stopped.

string

startedAt

string | null

status

required

queued, running, done or failed.

string

Example

{
  "id": "01966f3e-7c1a-7d3c-9a44-1d2f5a6b7c8d",
  "result": {
    "contentType": "application/pdf",
    "name": "invoice.pdf"
  },
  "status": "done"
}

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'"
}

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'"
}