Create Upload
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"sizeBytes": 123,
"checksumSha256": "<string>",
"notes": "",
"isConfidential": false,
"phases": [],
"documentTypes": [],
"typeId": "<string>",
"itemIds": []
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads"
payload = {
"name": "<string>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"sizeBytes": 123,
"checksumSha256": "<string>",
"notes": "",
"isConfidential": False,
"phases": [],
"documentTypes": [],
"typeId": "<string>",
"itemIds": []
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
requestId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
filename: '<string>',
sizeBytes: 123,
checksumSha256: '<string>',
notes: '',
isConfidential: false,
phases: [],
documentTypes: [],
typeId: '<string>',
itemIds: []
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads",
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([
'name' => '<string>',
'requestId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'filename' => '<string>',
'sizeBytes' => 123,
'checksumSha256' => '<string>',
'notes' => '',
'isConfidential' => false,
'phases' => [
],
'documentTypes' => [
],
'typeId' => '<string>',
'itemIds' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"requestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filename\": \"<string>\",\n \"sizeBytes\": 123,\n \"checksumSha256\": \"<string>\",\n \"notes\": \"\",\n \"isConfidential\": false,\n \"phases\": [],\n \"documentTypes\": [],\n \"typeId\": \"<string>\",\n \"itemIds\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"requestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filename\": \"<string>\",\n \"sizeBytes\": 123,\n \"checksumSha256\": \"<string>\",\n \"notes\": \"\",\n \"isConfidential\": false,\n \"phases\": [],\n \"documentTypes\": [],\n \"typeId\": \"<string>\",\n \"itemIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"requestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filename\": \"<string>\",\n \"sizeBytes\": 123,\n \"checksumSha256\": \"<string>\",\n \"notes\": \"\",\n \"isConfidential\": false,\n \"phases\": [],\n \"documentTypes\": [],\n \"typeId\": \"<string>\",\n \"itemIds\": []\n}"
response = http.request(request)
puts response.read_body{
"document": {
"id": "<string>",
"projectId": "<string>",
"companyId": "<string>",
"documentTypes": [
"<string>"
],
"scope": "project",
"typeId": "<string>",
"source": "file",
"status": "pending",
"name": "<string>",
"notes": "<string>",
"isConfidential": true,
"phases": [
"pre_design"
],
"itemIds": [
"<string>"
],
"externalUrl": "<string>",
"originalFilename": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"version": 123
},
"upload": {
"url": "<string>",
"fields": {},
"expiresAt": "<string>"
}
}Documents
Create Upload
POST
/
v1
/
workspaces
/
{workspaceId}
/
projects
/
{projectId}
/
documents
/
uploads
Create Upload
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"sizeBytes": 123,
"checksumSha256": "<string>",
"notes": "",
"isConfidential": false,
"phases": [],
"documentTypes": [],
"typeId": "<string>",
"itemIds": []
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads"
payload = {
"name": "<string>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"sizeBytes": 123,
"checksumSha256": "<string>",
"notes": "",
"isConfidential": False,
"phases": [],
"documentTypes": [],
"typeId": "<string>",
"itemIds": []
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
requestId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
filename: '<string>',
sizeBytes: 123,
checksumSha256: '<string>',
notes: '',
isConfidential: false,
phases: [],
documentTypes: [],
typeId: '<string>',
itemIds: []
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads', 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://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads",
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([
'name' => '<string>',
'requestId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'filename' => '<string>',
'sizeBytes' => 123,
'checksumSha256' => '<string>',
'notes' => '',
'isConfidential' => false,
'phases' => [
],
'documentTypes' => [
],
'typeId' => '<string>',
'itemIds' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"requestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filename\": \"<string>\",\n \"sizeBytes\": 123,\n \"checksumSha256\": \"<string>\",\n \"notes\": \"\",\n \"isConfidential\": false,\n \"phases\": [],\n \"documentTypes\": [],\n \"typeId\": \"<string>\",\n \"itemIds\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"requestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filename\": \"<string>\",\n \"sizeBytes\": 123,\n \"checksumSha256\": \"<string>\",\n \"notes\": \"\",\n \"isConfidential\": false,\n \"phases\": [],\n \"documentTypes\": [],\n \"typeId\": \"<string>\",\n \"itemIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/projects/{projectId}/documents/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"requestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"filename\": \"<string>\",\n \"sizeBytes\": 123,\n \"checksumSha256\": \"<string>\",\n \"notes\": \"\",\n \"isConfidential\": false,\n \"phases\": [],\n \"documentTypes\": [],\n \"typeId\": \"<string>\",\n \"itemIds\": []\n}"
response = http.request(request)
puts response.read_body{
"document": {
"id": "<string>",
"projectId": "<string>",
"companyId": "<string>",
"documentTypes": [
"<string>"
],
"scope": "project",
"typeId": "<string>",
"source": "file",
"status": "pending",
"name": "<string>",
"notes": "<string>",
"isConfidential": true,
"phases": [
"pre_design"
],
"itemIds": [
"<string>"
],
"externalUrl": "<string>",
"originalFilename": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"version": 123
},
"upload": {
"url": "<string>",
"fields": {},
"expiresAt": "<string>"
}
}Body
application/json
Required string length:
1 - 255Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
project, project_item, contact_company Required string length:
1 - 255Required range:
x <= 500000000Pattern:
^[0-9a-f]{64}$Maximum string length:
10000Maximum array length:
9Available options:
pre_design, programming, schematic_design, design_development, construction_documents, bidding_negotiation, procurement, construction_administration, closeout Maximum array length:
5Available options:
w9, coi, msa, price_list, nda Maximum array length:
1000⌘I