Render a PDF document into images

POST 
/v1/render

Render a PDF document into images.

Request

application/json

Body

required

document_url Document Url (string)required
The URL of the file to render. Supports two URL types:
    1. Public URLs - accessible from the internet

    2. `nomic://` prefixed URLs - obtained from the `/upload` endpoint

first_page

object

Starting page number for rendering (zero-indexed). If not specified, rendering starts from the first page of the file.

anyOf

MOD1

integer

Responses

201

The task id of the rendering task.

application/json

Schema

Schema

task_id Task Id (string)required

The id of the task.

Example (from schema)

{
  "task_id": "string"
}

403

The user is not authorized to perform this action.

application/json

Schema

Schema

any

Example (from schema)

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

Example

{
  "status_code": 403,
  "detail": "The user is not authorized to perform this action."
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...