Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Book Commands

Create Book

Create a <glossary:Book> that you can use to group related <glossary:Document>s. Each document must be uploaded to a <glossary:Book>, so you'll need to create one with this endpoint before you can upload files. <glossary:Book>s are generally used to store related <glossary:Document>s, such as for a loan application or a case file.

post/v1/book/add

Request body

namestring required

The name of the <glossary:Book> that will be created.

book_class'COMPLETE' | 'INSTANT' | 'INSTANT_CLASSIFY_ONLY' | 'INSTANT_CLASSIFY_ISO_CAPTURE'

The processing type of the book. Can be either 'COMPLETE' or 'INSTANT'. By default this value will be set to COMPLETE unless your organization is configured to have INSTANT as the default.

book_type'DEFAULT' | 'OPTIMA' | 'WIDGET'

Describes how the <glossary:Book> was created. This feature is in beta. See our guides on OPTIMA and WIDGET for additional information.

is_publicboolean

true allows all users in your organization to see and upload <glossary:Document>s into this <glossary:Book>.

xidstring

A free form field that can be used to associate a <glossary:Book> with some identity outside of Ocrolus.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "name": "Test Book",
    "created": "2022-11-11T10:03:06Z",
    "created_ts": "2022-11-11T10:03:06Z",
    "pk": 10399,
    "owner_email": "email@address.com",
    "uuid": "8dc88eed-2b6f-414a-82f2-a99bd181cf6e",
    "book_type": "DEFAULT",
    "xid": "ABC123",
    "id": 10399
  },
  "message": "OK"
}