curl --request POST \
--url https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"size": 125000000000,
"driveId": "<string>",
"itemId": "<string>",
"baseRevision": "<string>",
"folderId": "<string>",
"name": "<string>",
"conflictBehavior": "fail"
}
'import requests
url = "https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions"
payload = {
"size": 125000000000,
"driveId": "<string>",
"itemId": "<string>",
"baseRevision": "<string>",
"folderId": "<string>",
"name": "<string>",
"conflictBehavior": "fail"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
size: 125000000000,
driveId: '<string>',
itemId: '<string>',
baseRevision: '<string>',
folderId: '<string>',
name: '<string>',
conflictBehavior: 'fail'
})
};
fetch('https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions', 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.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'size' => 125000000000,
'driveId' => '<string>',
'itemId' => '<string>',
'baseRevision' => '<string>',
'folderId' => '<string>',
'name' => '<string>',
'conflictBehavior' => 'fail'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions"
payload := strings.NewReader("{\n \"size\": 125000000000,\n \"driveId\": \"<string>\",\n \"itemId\": \"<string>\",\n \"baseRevision\": \"<string>\",\n \"folderId\": \"<string>\",\n \"name\": \"<string>\",\n \"conflictBehavior\": \"fail\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"size\": 125000000000,\n \"driveId\": \"<string>\",\n \"itemId\": \"<string>\",\n \"baseRevision\": \"<string>\",\n \"folderId\": \"<string>\",\n \"name\": \"<string>\",\n \"conflictBehavior\": \"fail\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"size\": 125000000000,\n \"driveId\": \"<string>\",\n \"itemId\": \"<string>\",\n \"baseRevision\": \"<string>\",\n \"folderId\": \"<string>\",\n \"name\": \"<string>\",\n \"conflictBehavior\": \"fail\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"uploadUrl": "<string>",
"method": "PUT",
"size": 0,
"chunkSize": 10485760,
"expiresAt": "2023-11-07T05:31:56Z",
"instructions": "<string>",
"replaces": {
"itemId": "<string>",
"driveId": "<string>",
"previousRevision": "<string>"
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "needs_connection",
"message": "<string>"
}{
"error": "microsoft_graph_error",
"message": "<string>",
"outcome": "unknown",
"retryable": false
}Prepare an upload to OneDrive or SharePoint, or a replacement of an existing file's content, for a client with a shell
Prepare a Microsoft upload session for an explicitly requested upload. This does not upload bytes or prove completion. With itemId and baseRevision the upload replaces that file’s content as a new version; otherwise it creates name in folderId (or the top of the drive). Do not automatically create another session after an uncertain result. Uses the selected connection.
curl --request POST \
--url https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"size": 125000000000,
"driveId": "<string>",
"itemId": "<string>",
"baseRevision": "<string>",
"folderId": "<string>",
"name": "<string>",
"conflictBehavior": "fail"
}
'import requests
url = "https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions"
payload = {
"size": 125000000000,
"driveId": "<string>",
"itemId": "<string>",
"baseRevision": "<string>",
"folderId": "<string>",
"name": "<string>",
"conflictBehavior": "fail"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
size: 125000000000,
driveId: '<string>',
itemId: '<string>',
baseRevision: '<string>',
folderId: '<string>',
name: '<string>',
conflictBehavior: 'fail'
})
};
fetch('https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions', 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.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'size' => 125000000000,
'driveId' => '<string>',
'itemId' => '<string>',
'baseRevision' => '<string>',
'folderId' => '<string>',
'name' => '<string>',
'conflictBehavior' => 'fail'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions"
payload := strings.NewReader("{\n \"size\": 125000000000,\n \"driveId\": \"<string>\",\n \"itemId\": \"<string>\",\n \"baseRevision\": \"<string>\",\n \"folderId\": \"<string>\",\n \"name\": \"<string>\",\n \"conflictBehavior\": \"fail\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"size\": 125000000000,\n \"driveId\": \"<string>\",\n \"itemId\": \"<string>\",\n \"baseRevision\": \"<string>\",\n \"folderId\": \"<string>\",\n \"name\": \"<string>\",\n \"conflictBehavior\": \"fail\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/capabilities/microsoft-365/drive-upload-sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"size\": 125000000000,\n \"driveId\": \"<string>\",\n \"itemId\": \"<string>\",\n \"baseRevision\": \"<string>\",\n \"folderId\": \"<string>\",\n \"name\": \"<string>\",\n \"conflictBehavior\": \"fail\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"uploadUrl": "<string>",
"method": "PUT",
"size": 0,
"chunkSize": 10485760,
"expiresAt": "2023-11-07T05:31:56Z",
"instructions": "<string>",
"replaces": {
"itemId": "<string>",
"driveId": "<string>",
"previousRevision": "<string>"
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "needs_connection",
"message": "<string>"
}{
"error": "microsoft_graph_error",
"message": "<string>",
"outcome": "unknown",
"retryable": false
}Authorizations
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
Exact file size in bytes.
1 <= x <= 250000000000The file's driveId from a search, folder or link result. Omit for the member's own OneDrive.
1 - 512Replace this existing file's content. It keeps its link and sharing; the previous version stays in its version history.
1 - 512Required with itemId: the eTag your copy was downloaded from. Refused with drive_conflict when the file changed since; download it again and reapply the edits, or save a new file.
1 - 512^[\x20-\x7e]+$New files only: the folder to create the file in; omit for the top of the drive.
1 - 512New files only: the file name.
1 - 255New files only: fail, or let Microsoft rename the file when the name is taken.
fail, rename Response
Secret upload session; file not yet uploaded.
Secret bearer upload-session URL. Never print, share, persist or log it, and never send an Authorization header to it.
"PUT"-9007199254740991 <= x <= 9007199254740991^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Present when the upload replaces an existing file's content.
Show child attributes
Show child attributes
Was this page helpful?