Skip to main content
POST
/
documents
Upload Document
curl --request POST \
  --url https://api.usecobalt.com/v1/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>' \
  --form 'folder_name=<string>' \
  --form 'patient_mrn=<string>' \
  --form document='@example-file' \
  --form 'emr_assigned_to_id=<string>' \
  --form is_reviewed=true \
  --form 'notes=<string>' \
  --form is_high_priority=true \
  --form 'template_name=<string>' \
  --form 'location_id=<string>' \
  --form 'tags=<string>'
import requests

url = "https://api.usecobalt.com/v1/documents"

files = { "document": ("example-file", open("example-file", "rb")) }
payload = {
    "folder_name": "<string>",
    "patient_mrn": "<string>",
    "emr_assigned_to_id": "<string>",
    "is_reviewed": "true",
    "notes": "<string>",
    "is_high_priority": "true",
    "template_name": "<string>",
    "location_id": "<string>",
    "tags": "<string>"
}
headers = {
    "client_id": "<api-key>",
    "client_secret": "<api-key>",
    "access_token": "<api-key>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('folder_name', '<string>');
form.append('patient_mrn', '<string>');
form.append('document', '<string>');
form.append('emr_assigned_to_id', '<string>');
form.append('is_reviewed', 'true');
form.append('notes', '<string>');
form.append('is_high_priority', 'true');
form.append('template_name', '<string>');
form.append('location_id', '<string>');
form.append('tags', '<string>');

const options = {
  method: 'POST',
  headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};

options.body = form;

fetch('https://api.usecobalt.com/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usecobalt.com/v1/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "access_token: <api-key>",
    "client_id: <api-key>",
    "client_secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usecobalt.com/v1/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("client_id", "<api-key>")
	req.Header.Add("client_secret", "<api-key>")
	req.Header.Add("access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.usecobalt.com/v1/documents")
  .header("client_id", "<api-key>")
  .header("client_secret", "<api-key>")
  .header("access_token", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.usecobalt.com/v1/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>",
  "document_id": "<string>"
}
Documents are processed asynchronously. You’ll receive a webhook notification when the upload is complete or if there was an error.

​
Example Request

curl -X POST https://api.usecobalt.com/v1/documents \
-H 'Content-Type: multipart/form-data' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-F 'folder_name=MedicalRecords' \
-F 'patient_mrn=123456' \
-F 'location_id=20' \
-F 'tags=Estimate' \
-F 'tags=Referral' \
-F 'document=@/path/to/document.pdf'

​
Example Response

{
    "success": true,
    "message": "Document uploaded successfully. It will be processed soon.",
    "document_id": "9988776655443322"
}

​
Example Success Webhook

{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "object": "event",
    "created": "2023-10-01T12:34:56Z",
    "type": "document.uploaded",
    "data": {
        "document_id": "9988776655443322",
        "patient_mrn": "123456",
        "folder_name": "MedicalRecords"
    }
}

​
Example Failure Webhook

{
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "object": "event",
    "created": "2023-10-01T12:34:56Z",
    "type": "document.upload_failed",
    "data": {
        "document_id": "9988776655443322",
        "patient_mrn": "123456",
        "folder_name": "MedicalRecords",
        "failure_reason": "Patient not found. Please check the patient MRN and try again."
    }
}

Authorizations

​
client_id
string
header
required
​
client_secret
string
header
required
​
access_token
string
header
required

Body

multipart/form-data
​
folder_name
string
required

The name of the folder where the document will be stored. Supports nested folders using forward slashes (e.g., 'MedicalRecords/LabResults').

​
patient_mrn
string
required

The medical record number of the patient.

​
document
file
required

The document file to be uploaded. Only PDF, JPEG, and PNG files are allowed. Maximum file size is 10MB.

​
emr_assigned_to_id
string

The EMR staff ID to assign the document to. Must match a staff member in your organization's staff list.

​
is_reviewed
boolean

Mark the document as reviewed. Defaults to false.

​
notes
string

Description or notes for the document. Maximum 1000 characters.

​
is_high_priority
boolean

Mark the document as high priority. Defaults to false.

​
template_name
string

The template name to use when filling out the document upload form.

​
location_id
string

The EMR ID of the location/facility to associate with the document. Must match a location returned by GET /locations.

​
tags
string[]

Zero or more tag names to apply to the document. Repeat the field in multipart form data to send multiple tags.

Response

200 - application/json

Successful response

​
success
boolean
​
message
string
​
document_id
string