List the files a print can be fetched as

GET

/v1/prints/{id}/files

const url = 'https://api.pixonaut.app/v1/prints/example/files?form=flat';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.pixonaut.app/v1/prints/example/files?form=flat' \
  --header 'Authorization: Bearer <token>'

Operation ID: prints.files.list

Every file the print can be handed out as: as stored, for machineProfile, any machine profile of the tenant’s printshops, or for settings, output settings asked for one download (a JSON object, as the order’s list of files takes it): each part (combined, print, cut) of the process file and, where the print has one, the separated file, with the address it is fetched from. settings answers the settings the files are drawn with, null when none are drawn (a print whose ticket cannot be read). machineProfiles lists the profiles to choose from, each with its printshop; a studio member sees them, and may ask for one, only with printshops:read. counted says whether the print was counted as an order already, so getting its files is free. fileForm is the form the print was made in (flat; layered: each printed layer its own optional content group, every glyph a path; or layered_live_text: plain text live as well), layeredFallback and liveTextFallback why it has no file in those forms where it has none, and forms each form with whether its files are made yet and why it is refused where it is; form lists the files of that form, their addresses asking for it.

Authorizations

secretKey
integrationKey

Parameters

Path Parameters

required

string

Query Parameters

machineProfile

string

settings

string

form

Which form of the print’s files: flat, layered (each printed layer its own optional content group, every glyph a path) or layered_live_text (plain text live as well). Left out, the form the print was made in. Another form is made from the print’s document when it is first asked for, and kept.

string

Allowed values: flat layered layered_live_text

Responses

200

The print’s files

application/json

object

counted

required

One of:

object

required

number

required

object

kind

required

string

name

required

string

viaMcp

required

boolean

kind

required

string

Allowed values: files

fileForm

required

string

formAsked

required

string

forms

required

Array<object>

object

form

required

string

made

required

boolean

own

required

boolean

refusedBecause

required

string | null

layeredFallback

required

string | null

liveTextFallback

required

string | null

machineProfileAskedId

required

string | null

machineProfiles

required

Array<object>

object

required

string

name

required

string

printshop

required

string

separationMissing

required

boolean

settings

required

object

bleedTrimMm

required

The bleed the file is trimmed to, in mm, or null for the bleed it was rendered with.

number | null

<= 50

cropMarks

required

Whether crop marks are drawn for a rectangular cut.

boolean

cutName

required

The name the cut path is drawn under, or null for a machine that cuts nothing.

string | null

markOffsetMm

required

How much further out than by default the marks sit, in mm.

number

<= 50

mirror

required

Whether the print is mirrored.

boolean

registrationMarks

required

The marks the machine reads off the printed sheet.

string

underbase

required

A UV machine’s white laid under the colour, or null for none.

object

chokeMm

required

How far in from the inked edge the white stops, in mm; 0 leaves it to the RIP.

number

<= 5

coverage

required

Where the white lies.

string

spotName

required

The spot name the printshop’s RIP reads for this channel.

string

>= 1 characters <= 64 characters

varnish

required

A UV machine’s varnish laid over the colour, or null for none.

object

coverage

required

Where the varnish lies when the design marks no layer for spot varnish.

string

spotName

required

The spot name the printshop’s RIP reads for this channel.

string

>= 1 characters <= 64 characters

variants

required

Array<object>

object

file

required

string

handedOut

required

boolean

isDefault

required

boolean

part

required

string

url

required

string

Examples

example

Example

{
  "counted": null,
  "fileForm": "flat",
  "formAsked": "flat",
  "forms": [
    {
      "form": "flat",
      "made": true,
      "own": true,
      "refusedBecause": null
    },
    {
      "form": "layered",
      "made": false,
      "own": false,
      "refusedBecause": null
    },
    {
      "form": "layered_live_text",
      "made": false,
      "own": false,
      "refusedBecause": null
    }
  ],
  "layeredFallback": null,
  "liveTextFallback": null,
  "machineProfileAskedId": null,
  "machineProfiles": [
    {
      "id": "5d6e7f80-9a1b-4c2d-8e3f-4a5b6c7d8e9f",
      "name": "Epson F2270 DTG",
      "printshop": "Nordic Print Works"
    }
  ],
  "separationMissing": false,
  "settings": {
    "bleedTrimMm": null,
    "cropMarks": false,
    "cutName": null,
    "markOffsetMm": 0,
    "mirror": false,
    "registrationMarks": "none",
    "underbase": null,
    "varnish": null
  },
  "variants": [
    {
      "file": "process",
      "handedOut": false,
      "isDefault": true,
      "part": "print",
      "url": "/v1/prints/c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f/file?part=print&file=process"
    }
  ]
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

401

Refused: unauthorized

application/json

object

error

required

string

Examples

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

403

Refused: origin_forbidden, forbidden, feature_disabled, workspace_suspended

application/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

forbidden

{
  "error": "forbidden"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

workspace_suspended

{
  "error": "workspace_suspended"
}

Headers

X-Request-Id

required

string

404

Refused: print_not_found, machine_profile_not_found, not_found

application/json

object

error

required

string

Examples

machine_profile_not_found

{
  "error": "machine_profile_not_found"
}

not_found

{
  "error": "not_found"
}

print_not_found

{
  "error": "print_not_found"
}

Headers

X-Request-Id

required

string

422

Refused: invalid_query

application/json

object

error

required

string

Examples

invalid_query

{
  "error": "invalid_query"
}

Headers

X-Request-Id

required

string

500

Refused: db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

db_error

{
  "error": "db_error"
}

Headers

X-Request-Id

required

string

Questions? Write to [email protected].

Status · Terms of service · Privacy policy · Subprocessors