Create upload session
curl --request POST \
--url https://api.ofauth.com/v2/access/uploads/init \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--header 'x-connection-id: <api-key>' \
--data '
{
"filename": "<string>",
"size": 1,
"contentType": "<string>",
"vaultUpload": {
"mode": "message",
"userId": "<string>"
}
}
'import requests
url = "https://api.ofauth.com/v2/access/uploads/init"
payload = {
"filename": "<string>",
"size": 1,
"contentType": "<string>",
"vaultUpload": {
"mode": "message",
"userId": "<string>"
}
}
headers = {
"apiKey": "<api-key>",
"x-connection-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
apiKey: '<api-key>',
'x-connection-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filename: '<string>',
size: 1,
contentType: '<string>',
vaultUpload: {mode: 'message', userId: '<string>'}
})
};
fetch('https://api.ofauth.com/v2/access/uploads/init', 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.ofauth.com/v2/access/uploads/init",
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([
'filename' => '<string>',
'size' => 1,
'contentType' => '<string>',
'vaultUpload' => [
'mode' => 'message',
'userId' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>",
"x-connection-id: <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.ofauth.com/v2/access/uploads/init"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"size\": 1,\n \"contentType\": \"<string>\",\n \"vaultUpload\": {\n \"mode\": \"message\",\n \"userId\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apiKey", "<api-key>")
req.Header.Add("x-connection-id", "<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.ofauth.com/v2/access/uploads/init")
.header("apiKey", "<api-key>")
.header("x-connection-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"size\": 1,\n \"contentType\": \"<string>\",\n \"vaultUpload\": {\n \"mode\": \"message\",\n \"userId\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ofauth.com/v2/access/uploads/init")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["x-connection-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": \"<string>\",\n \"size\": 1,\n \"contentType\": \"<string>\",\n \"vaultUpload\": {\n \"mode\": \"message\",\n \"userId\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"mediaUploadId": "<string>",
"totalParts": 1,
"partSize": 1,
"expiresAt": "<string>",
"parts": [
{
"partNumber": 1,
"uploadUrl": "<string>",
"byteRange": {
"start": 1,
"end": 1
}
}
],
"completeUrl": "<string>"
}Uploads
Create upload session
deprecated
Create upload session
Permission Required: vault:write
POST
/
v2
/
access
/
uploads
/
init
Create upload session
curl --request POST \
--url https://api.ofauth.com/v2/access/uploads/init \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--header 'x-connection-id: <api-key>' \
--data '
{
"filename": "<string>",
"size": 1,
"contentType": "<string>",
"vaultUpload": {
"mode": "message",
"userId": "<string>"
}
}
'import requests
url = "https://api.ofauth.com/v2/access/uploads/init"
payload = {
"filename": "<string>",
"size": 1,
"contentType": "<string>",
"vaultUpload": {
"mode": "message",
"userId": "<string>"
}
}
headers = {
"apiKey": "<api-key>",
"x-connection-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
apiKey: '<api-key>',
'x-connection-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filename: '<string>',
size: 1,
contentType: '<string>',
vaultUpload: {mode: 'message', userId: '<string>'}
})
};
fetch('https://api.ofauth.com/v2/access/uploads/init', 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.ofauth.com/v2/access/uploads/init",
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([
'filename' => '<string>',
'size' => 1,
'contentType' => '<string>',
'vaultUpload' => [
'mode' => 'message',
'userId' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>",
"x-connection-id: <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.ofauth.com/v2/access/uploads/init"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"size\": 1,\n \"contentType\": \"<string>\",\n \"vaultUpload\": {\n \"mode\": \"message\",\n \"userId\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apiKey", "<api-key>")
req.Header.Add("x-connection-id", "<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.ofauth.com/v2/access/uploads/init")
.header("apiKey", "<api-key>")
.header("x-connection-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"size\": 1,\n \"contentType\": \"<string>\",\n \"vaultUpload\": {\n \"mode\": \"message\",\n \"userId\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ofauth.com/v2/access/uploads/init")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["x-connection-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": \"<string>\",\n \"size\": 1,\n \"contentType\": \"<string>\",\n \"vaultUpload\": {\n \"mode\": \"message\",\n \"userId\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"mediaUploadId": "<string>",
"totalParts": 1,
"partSize": 1,
"expiresAt": "<string>",
"parts": [
{
"partNumber": 1,
"uploadUrl": "<string>",
"byteRange": {
"start": 1,
"end": 1
}
}
],
"completeUrl": "<string>"
}Authorizations
Requires a connection via the x-connection-id header.
Body
application/json
Name of the file to upload
Minimum string length:
1File size in bytes
Required range:
x > 0MIME type of the file (e.g., image/jpeg, video/mp4)
Minimum string length:
1Options for vault upload (if uploading to vault)
Show child attributes
Show child attributes
Response
Successful response
Was this page helpful?
⌘I