Upload a document to a Vault
Uploads a document to a Vault, optionally forcing the document type. Use v3 POST /v3/documents for new integrations.
Legacy note: this endpoint is maintained for existing V2 integrations. Prefer V3 for new API and agent workflows where an equivalent exists.
curl -X POST "https://api.textmine.com/v1/vaults/example_string/documents" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
--form file=example_string \
--form documentType=employment-agreement
import requests
import json
url = "https://api.textmine.com/v1/vaults/example_string/documents"
headers = {
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"file": "example_string",
"documentType": "employment-agreement"
}
response = requests.post(url, headers=headers, data=data)
print(response.json())
const formData = new FormData();
formData.append("file", "example_string");
formData.append("documentType", "employment-agreement");
const response = await fetch("https://api.textmine.com/v1/vaults/example_string/documents", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: formData
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"mime/multipart"
)
func main() {
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
writer.WriteField("file", "example_string")
writer.WriteField("documentType", "employment-agreement")
writer.Close()
req, err := http.NewRequest("POST", "https://api.textmine.com/v1/vaults/example_string/documents", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <ACCESS_TOKEN>")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Set("Content-Type", writer.FormDataContentType())
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.textmine.com/v1/vaults/example_string/documents')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <ACCESS_TOKEN>'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.set_form([
["file", "example_string"],
["documentType", "employment-agreement"]
], 'multipart/form-data')
response = http.request(request)
puts response.body
{}
POST
/v1/vaults/{vaultId}/documentsPOST
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token
Bearer Tokenstring
RequiredBearer token - just enter the token, "Bearer" prefix will be added automatically
Content-Typestring
RequiredThe media type of the request body
Options: multipart/form-data
filefile
Format: binary
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Authentication token required.
Path Parameters
Headers
Authorizationstring
Example:
Bearer <ACCESS_TOKEN>Responses
Successful response
Was this page helpful?