DocumentInput

One document to create: its file name and type and, optionally, your own id and data.

  • The file's type, which sets how it is processed: one of application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, application/json, text/csv, application/yaml, application/x-yaml, text/yaml, application/zip, application/x-zip-compressed. Brellium unpacks zips (see POST /v2/documents). The API ignores case and parameters such as ; charset=utf-8; upload.headers gives the Content-Type for the PUT.

  • The file's name, 1 to 255 characters, with no slashes, backslashes or control characters. It can have any extension or none, because the type comes from content_type. The API keeps the name exactly as sent.

  • Your own identifier, up to 255 characters, unique within your organization and the request. It makes the request safe to retry (see POST /v2/documents). When the batch expires, the value is released, so you can send the batch again with it.

  • Any JSON object of your own data, stored and returned unchanged. Replace it later with PATCH /v2/documents/{document_id}.

    Properties: 1