Create a document
curl --request POST \
--url https://api.wellapp.ai/v1/documents \
--header 'Authorization: <authorization>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'data.type=<string>' \
--form 'data.attributes.file_name=<string>' \
--form data.attributes.workspace_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form data.attributes.external_workspace_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form data.attributes.collect_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.attributes.metadata.source_number=<string>' \
--form 'data.attributes.metadata.target_number=<string>' \
--form 'data.relationships.workspace.data.type=<string>' \
--form data.relationships.workspace.data.id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.relationships.company.data.type=<string>' \
--form data.relationships.company.data.id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.relationships.people.data.type=<string>' \
--form data.relationships.people.data.id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.relationships.people.data.meta.phone_number=<string>'import requests
url = "https://api.wellapp.ai/v1/documents"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"data.type": "<string>",
"data.attributes.file_name": "<string>",
"data.attributes.workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.attributes.external_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.attributes.collect_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.attributes.metadata.source_number": "<string>",
"data.attributes.metadata.target_number": "<string>",
"data.relationships.workspace.data.type": "<string>",
"data.relationships.workspace.data.id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.company.data.type": "<string>",
"data.relationships.company.data.id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.people.data.type": "<string>",
"data.relationships.people.data.id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.people.data.meta.phone_number": "<string>"
}
headers = {"Authorization": "<authorization>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('data.type', '<string>');
form.append('data.attributes.file_name', '<string>');
form.append('data.attributes.workspace_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.attributes.external_workspace_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.attributes.collect_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.attributes.metadata.source_number', '<string>');
form.append('data.attributes.metadata.target_number', '<string>');
form.append('data.relationships.workspace.data.type', '<string>');
form.append('data.relationships.workspace.data.id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.company.data.type', '<string>');
form.append('data.relationships.company.data.id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.people.data.type', '<string>');
form.append('data.relationships.people.data.id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.people.data.meta.phone_number', '<string>');
const options = {method: 'POST', headers: {Authorization: '<authorization>'}};
options.body = form;
fetch('https://api.wellapp.ai/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.wellapp.ai/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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: multipart/form-data"
],
]);
$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.wellapp.ai/v1/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.wellapp.ai/v1/documents")
.header("Authorization", "<authorization>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wellapp.ai/v1/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"file_name": "invoice_2024.pdf",
"workspace_id": "550e8400-e29b-41d4-a716-446655440001",
"collect_id": "550e8400-e29b-41d4-a716-446655440002",
"metadata": {
"source_number": "+33123456789",
"target_number": "+33987654321",
"document_type": "invoice"
},
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-20T10:30:00Z"
},
"relationships": {
"workspace": {
"data": {
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001"
}
},
"company": {
"data": {
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440003"
}
},
"people": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440004",
"meta": {
"phone_number": "+33123456789"
}
}
}
}
},
"included": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"name": "Sales Team Workspace",
"description": "Workspace for sales documents and invoices",
"avatar_color": "#4A90E2",
"external_workspace_id": "sales_ws_001",
"auto_extract_enabled": true,
"created_at": "2024-01-15T09:00:00Z",
"updated_at": "2024-01-15T09:00:00Z"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440003",
"attributes": {
"name": "ACME Corporation",
"description": "Leading technology and consulting company",
"locale": "fr",
"domain_name_primary_link_url": "acme.com",
"tax_id": {
"value": "FR12345678901",
"type": "VAT"
},
"registration": {
"trade_name": "ACME",
"registered_name": "ACME Corporation SAS"
},
"registration_number": {
"business_type": "SAS",
"value": "RCS 123456789",
"registry_name": "Registre du Commerce Paris",
"registry_country": "FR"
},
"created_at": "2024-01-10T08:00:00Z",
"updated_at": "2024-01-10T08:00:00Z"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440004",
"attributes": {
"first_name": "Jean",
"last_name": "Dupont",
"full_name": "Jean Dupont",
"created_at": "2024-01-12T10:00:00Z",
"updated_at": "2024-01-12T10:00:00Z"
}
}
]
}{
"code": "SCHEMA_VALIDATION_ERROR",
"status": 400,
"title": "Validation Error",
"message": "The request is invalid",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
},
"details": [
{
"instancePath": "<string>",
"schemaPath": "<string>",
"keyword": "<string>",
"params": {},
"message": "<string>"
}
]
}{
"code": "UNAUTHORIZED",
"status": 401,
"title": "Unauthorized",
"message": "You are not authorized to access this resource",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
}
}{
"code": "COMPANY_OR_PERSON_NOT_FOUND",
"status": 404,
"title": "Company or Person Not Found",
"message": "The requested company or one of the specified people could not be found",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
}
}{
"code": "PAYLOAD_TOO_LARGE",
"status": 413,
"title": "Payload Too Large",
"message": "The uploaded file exceeds the maximum allowed size",
"meta": {
"log_id": "550e8400-e29b-41d4-a716-446655440999"
}
}Documents
Create Document
Create a new document record with file and metadata
POST
/
v1
/
documents
Create a document
curl --request POST \
--url https://api.wellapp.ai/v1/documents \
--header 'Authorization: <authorization>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'data.type=<string>' \
--form 'data.attributes.file_name=<string>' \
--form data.attributes.workspace_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form data.attributes.external_workspace_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form data.attributes.collect_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.attributes.metadata.source_number=<string>' \
--form 'data.attributes.metadata.target_number=<string>' \
--form 'data.relationships.workspace.data.type=<string>' \
--form data.relationships.workspace.data.id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.relationships.company.data.type=<string>' \
--form data.relationships.company.data.id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.relationships.people.data.type=<string>' \
--form data.relationships.people.data.id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
--form 'data.relationships.people.data.meta.phone_number=<string>'import requests
url = "https://api.wellapp.ai/v1/documents"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"data.type": "<string>",
"data.attributes.file_name": "<string>",
"data.attributes.workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.attributes.external_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.attributes.collect_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.attributes.metadata.source_number": "<string>",
"data.attributes.metadata.target_number": "<string>",
"data.relationships.workspace.data.type": "<string>",
"data.relationships.workspace.data.id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.company.data.type": "<string>",
"data.relationships.company.data.id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.people.data.type": "<string>",
"data.relationships.people.data.id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.people.data.meta.phone_number": "<string>"
}
headers = {"Authorization": "<authorization>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('data.type', '<string>');
form.append('data.attributes.file_name', '<string>');
form.append('data.attributes.workspace_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.attributes.external_workspace_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.attributes.collect_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.attributes.metadata.source_number', '<string>');
form.append('data.attributes.metadata.target_number', '<string>');
form.append('data.relationships.workspace.data.type', '<string>');
form.append('data.relationships.workspace.data.id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.company.data.type', '<string>');
form.append('data.relationships.company.data.id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.people.data.type', '<string>');
form.append('data.relationships.people.data.id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.people.data.meta.phone_number', '<string>');
const options = {method: 'POST', headers: {Authorization: '<authorization>'}};
options.body = form;
fetch('https://api.wellapp.ai/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.wellapp.ai/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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: multipart/form-data"
],
]);
$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.wellapp.ai/v1/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.wellapp.ai/v1/documents")
.header("Authorization", "<authorization>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wellapp.ai/v1/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.file_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.collect_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.source_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.attributes.metadata.target_number\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspace.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.company.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data.meta.phone_number\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"file_name": "invoice_2024.pdf",
"workspace_id": "550e8400-e29b-41d4-a716-446655440001",
"collect_id": "550e8400-e29b-41d4-a716-446655440002",
"metadata": {
"source_number": "+33123456789",
"target_number": "+33987654321",
"document_type": "invoice"
},
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-20T10:30:00Z"
},
"relationships": {
"workspace": {
"data": {
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001"
}
},
"company": {
"data": {
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440003"
}
},
"people": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440004",
"meta": {
"phone_number": "+33123456789"
}
}
}
}
},
"included": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"name": "Sales Team Workspace",
"description": "Workspace for sales documents and invoices",
"avatar_color": "#4A90E2",
"external_workspace_id": "sales_ws_001",
"auto_extract_enabled": true,
"created_at": "2024-01-15T09:00:00Z",
"updated_at": "2024-01-15T09:00:00Z"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440003",
"attributes": {
"name": "ACME Corporation",
"description": "Leading technology and consulting company",
"locale": "fr",
"domain_name_primary_link_url": "acme.com",
"tax_id": {
"value": "FR12345678901",
"type": "VAT"
},
"registration": {
"trade_name": "ACME",
"registered_name": "ACME Corporation SAS"
},
"registration_number": {
"business_type": "SAS",
"value": "RCS 123456789",
"registry_name": "Registre du Commerce Paris",
"registry_country": "FR"
},
"created_at": "2024-01-10T08:00:00Z",
"updated_at": "2024-01-10T08:00:00Z"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440004",
"attributes": {
"first_name": "Jean",
"last_name": "Dupont",
"full_name": "Jean Dupont",
"created_at": "2024-01-12T10:00:00Z",
"updated_at": "2024-01-12T10:00:00Z"
}
}
]
}{
"code": "SCHEMA_VALIDATION_ERROR",
"status": 400,
"title": "Validation Error",
"message": "The request is invalid",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
},
"details": [
{
"instancePath": "<string>",
"schemaPath": "<string>",
"keyword": "<string>",
"params": {},
"message": "<string>"
}
]
}{
"code": "UNAUTHORIZED",
"status": 401,
"title": "Unauthorized",
"message": "You are not authorized to access this resource",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
}
}{
"code": "COMPANY_OR_PERSON_NOT_FOUND",
"status": 404,
"title": "Company or Person Not Found",
"message": "The requested company or one of the specified people could not be found",
"meta": {
"log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
}
}{
"code": "PAYLOAD_TOO_LARGE",
"status": 413,
"title": "Payload Too Large",
"message": "The uploaded file exceeds the maximum allowed size",
"meta": {
"log_id": "550e8400-e29b-41d4-a716-446655440999"
}
}Headers
Bearer token for authentication
Body
multipart/form-data
The document file to upload (PDF, image, Word document, etc.)
Resource type identifier
Allowed value:
"document"Name of the document file
Required string length:
1 - 255Workspace UUID
External Workspace UUID
Collection UUID (optional)
Source phone number for the document
Target phone number for the document
Type of document classification. See all document types for complete list.
Available options:
invoice, receipt, purchase_order, ... Type for workspace relationship
Allowed value:
"workspace"UUID of the workspace to associate with this document
Type for company relationship
Allowed value:
"company"UUID of the company to associate with this document
Type for people relationship
Allowed value:
"people"UUID of the person to associate with this document
Phone number to identify the person (alternative to ID)
⌘I