🟢API for PDF report

This page contains description how to download a PDF report via API.

If you want to view and share algorithms results to the user, you can generate a PDF report like this:

1MB

demo_pdf_report.pdf

pdf

Example of PDF report

About PDF reports

What can you do?

• Generate a PDF report for an image

---

Generate a PDF report for an image

Make a PDF for an image

Make a PDF of the given image.

Arguments: company_id -- company UUID dataset_id -- dataset UUID subject_id -- subject UUID batch_id -- batch UUID image_id -- image UUID

Keyword Arguments: access_token -- token without the "Bearer: " prefix options -- JSON object with timeout and waitUntil fields

Returns: fastapi.responses.FileResponse: a generated PDF

POST/service/pdf-generator/images/{image_id}/pdf/

Authorization

HTTPBearer

Path parameters

image_id*Image Id

Body

application/json

timeoutTimeout

waitUntilWaituntil

stringarray of string

Response

200400422

Successful Response

Request

JavaScriptCurlPython

const response = await fetch('/service/pdf-generator/images/{image_id}/pdf/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}