OCocrolus
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.

📘 Note > This endpoint can return errors with an HTTP 200 status code. In such cases, the response body contains an error code and message instead of the expected success response. To view the error response schema, select Error from the schema dropdown above.

post/v1/book/add

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/book/add
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

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' | 'INSTANT_ML' | 'WIDGET'

Describes how the <glossary:Book> was created. This feature is in beta. To learn more, see WIDGET guide.

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

OR

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

Changes

No recorded changes to this operation across all 1 revision of this API.