Upload a document

Redline API›Documents

POSThttps://api.redline.example/v1/matters/{matter_id}/documents

AuthRequires authentication via bearerAuth.

Description

Uploads a PDF or DOCX file to a Matter as a new document version.

Request

cURLJavaScriptPython

Copy

curl -X POST "https://api.redline.example/v1/matters/mat_01JAZ6Q7K2/documents" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "file": "string",
  "kind": "draft",
  "name": "Aster Peak MSA v3.docx",
  "source_document_id": "doc_01JAZ6ZXM4"
}'

const response = await fetch("https://api.redline.example/v1/matters/mat_01JAZ6Q7K2/documents", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "file": "string",
      "kind": "draft",
      "name": "Aster Peak MSA v3.docx",
      "source_document_id": "doc_01JAZ6ZXM4"
    }),
});

import requests

response = requests.post(
    "https://api.redline.example/v1/matters/mat_01JAZ6Q7K2/documents",
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
    json={
      "file": "string",
      "kind": "draft",
      "name": "Aster Peak MSA v3.docx",
      "source_document_id": "doc_01JAZ6ZXM4"
    },
)

Response201JSONCopy

{
  "id": "doc_01JAZ7C3V9",
  "matter_id": "mat_01JAZ6Q7K2",
  "name": "Aster Peak MSA v3.docx",
  "kind": "draft",
  "media_type": "string",
  "size_bytes": 0,
  "version_number": 0,
  "source_document_id": "string",
  "created_at": "2024-01-01T00:00:00Z"
}

Parameters

matter_idpathstringrequired

Matter identifier.

Request body

multipart/form-datarequired

filebodystring <binary>required

PDF or DOCX content, up to 50 MB.

kindbodystringrequired

Role of a document in the Matter.

namebodystring

Display name. Defaults to the uploaded file name.

source_document_idbodystring

Prior document when this upload is a new version.

Responses

201The uploaded document metadata.application/json

idstringrequired

matter_idstringrequired

namestringrequired

kindstringrequired

Role of a document in the Matter.

media_typestringrequired

Media type detected during upload.

size_bytesintegerrequired

File size in bytes.

version_numberintegerrequired

Sequential version within its document history.

source_document_idstring | null

Prior version when applicable.

created_atstring <date-time>required

401The API key is missing, malformed, expired, or revoked.application/json

errorobjectrequired

403The API key does not have permission for this action.application/json

errorobjectrequired

404The resource was not found in the authenticated Workspace.application/json

errorobjectrequired

413The document exceeds the 50 MB upload limit.application/json

errorobjectrequired

415The document type is not supported.application/json

errorobjectrequired

422One or more request fields are invalid.application/json

errorobjectrequired