Create media
curl --request POST \
--url https://api.wellapp.ai/v1/medias \
--header 'Authorization: <authorization>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'data.type=<string>' \
--form data.attributes.is_primary=true \
--form 'data.relationships.people.data[].type=<string>' \
--form 'data.relationships.people.data[].id=3c90c3cc-0d44-4b50-8888-8dd25736052a' \
--form 'data.relationships.companies.data[].type=<string>' \
--form 'data.relationships.companies.data[].id=3c90c3cc-0d44-4b50-8888-8dd25736052a' \
--form 'data.relationships.workspaces.data[].type=<string>' \
--form 'data.relationships.workspaces.data[].id=3c90c3cc-0d44-4b50-8888-8dd25736052a' \
--form 'data.relationships.workspaces.data[].external_workspace_id=3c90c3cc-0d44-4b50-8888-8dd25736052a'import requests
url = "https://api.wellapp.ai/v1/medias"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"data.type": "<string>",
"data.attributes.is_primary": "true",
"data.relationships.people.data[].type": "<string>",
"data.relationships.people.data[].id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.companies.data[].type": "<string>",
"data.relationships.companies.data[].id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.workspaces.data[].type": "<string>",
"data.relationships.workspaces.data[].id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.workspaces.data[].external_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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.is_primary', 'true');
form.append('data.relationships.people.data[].type', '<string>');
form.append('data.relationships.people.data[].id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.companies.data[].type', '<string>');
form.append('data.relationships.companies.data[].id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.workspaces.data[].type', '<string>');
form.append('data.relationships.workspaces.data[].id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.workspaces.data[].external_workspace_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
const options = {method: 'POST', headers: {Authorization: '<authorization>'}};
options.body = form;
fetch('https://api.wellapp.ai/v1/medias', 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/medias",
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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\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/medias"
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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\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/medias")
.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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wellapp.ai/v1/medias")
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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": [
{
"type": "media",
"id": "media1",
"attributes": {
"media_type": "avatar",
"url": "https://cdn.example.com/avatar.jpg",
"is_primary": true,
"uploaded_at": "2025-06-01T10:00:00Z",
"processed_at": "2025-06-01T10:00:00Z"
},
"relationships": {
"people": {
"data": [
{
"type": "people",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77c"
}
]
},
"companies": {
"data": [
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a"
}
]
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77b"
}
]
}
},
"included": [
{
"type": "people",
"id": "people1",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"job_title": "Software Engineer",
"created_at": "2025-05-01T09:00:00Z",
"updated_at": "2025-06-01T10:00:00Z"
}
},
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a",
"attributes": {
"name": "Tech Startup Inc",
"description": "An innovative technology company focused on AI and ML solutions",
"registration_tax_id": "12345678901",
"registration_registered_value": "123456789",
"created_at": "2025-08-03T10:38:40.967Z",
"updated_at": "2025-08-04T07:51:01.785Z"
}
},
{
"type": "workspace",
"id": "workspace_tenant",
"attributes": {
"name": "Marketing Team Workspace",
"description": "Collaborative workspace for the marketing team to manage campaigns and content",
"external_workspace_id": "fygr_123",
"created_at": "2024-01-05T08:00:00Z",
"updated_at": "2024-01-18T12:15: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"
}
}Media
Create Media
Create a new media record with relationships to people, companies, or workspaces
POST
/
v1
/
medias
Create media
curl --request POST \
--url https://api.wellapp.ai/v1/medias \
--header 'Authorization: <authorization>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'data.type=<string>' \
--form data.attributes.is_primary=true \
--form 'data.relationships.people.data[].type=<string>' \
--form 'data.relationships.people.data[].id=3c90c3cc-0d44-4b50-8888-8dd25736052a' \
--form 'data.relationships.companies.data[].type=<string>' \
--form 'data.relationships.companies.data[].id=3c90c3cc-0d44-4b50-8888-8dd25736052a' \
--form 'data.relationships.workspaces.data[].type=<string>' \
--form 'data.relationships.workspaces.data[].id=3c90c3cc-0d44-4b50-8888-8dd25736052a' \
--form 'data.relationships.workspaces.data[].external_workspace_id=3c90c3cc-0d44-4b50-8888-8dd25736052a'import requests
url = "https://api.wellapp.ai/v1/medias"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"data.type": "<string>",
"data.attributes.is_primary": "true",
"data.relationships.people.data[].type": "<string>",
"data.relationships.people.data[].id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.companies.data[].type": "<string>",
"data.relationships.companies.data[].id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.workspaces.data[].type": "<string>",
"data.relationships.workspaces.data[].id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data.relationships.workspaces.data[].external_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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.is_primary', 'true');
form.append('data.relationships.people.data[].type', '<string>');
form.append('data.relationships.people.data[].id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.companies.data[].type', '<string>');
form.append('data.relationships.companies.data[].id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.workspaces.data[].type', '<string>');
form.append('data.relationships.workspaces.data[].id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('data.relationships.workspaces.data[].external_workspace_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
const options = {method: 'POST', headers: {Authorization: '<authorization>'}};
options.body = form;
fetch('https://api.wellapp.ai/v1/medias', 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/medias",
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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\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/medias"
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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\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/medias")
.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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wellapp.ai/v1/medias")
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.is_primary\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.people.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.companies.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data.relationships.workspaces.data%5B%5D.external_workspace_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": [
{
"type": "media",
"id": "media1",
"attributes": {
"media_type": "avatar",
"url": "https://cdn.example.com/avatar.jpg",
"is_primary": true,
"uploaded_at": "2025-06-01T10:00:00Z",
"processed_at": "2025-06-01T10:00:00Z"
},
"relationships": {
"people": {
"data": [
{
"type": "people",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77c"
}
]
},
"companies": {
"data": [
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a"
}
]
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77b"
}
]
}
},
"included": [
{
"type": "people",
"id": "people1",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"job_title": "Software Engineer",
"created_at": "2025-05-01T09:00:00Z",
"updated_at": "2025-06-01T10:00:00Z"
}
},
{
"type": "company",
"id": "b6c22e98-c8d0-485e-9d3d-caa2bbaff77a",
"attributes": {
"name": "Tech Startup Inc",
"description": "An innovative technology company focused on AI and ML solutions",
"registration_tax_id": "12345678901",
"registration_registered_value": "123456789",
"created_at": "2025-08-03T10:38:40.967Z",
"updated_at": "2025-08-04T07:51:01.785Z"
}
},
{
"type": "workspace",
"id": "workspace_tenant",
"attributes": {
"name": "Marketing Team Workspace",
"description": "Collaborative workspace for the marketing team to manage campaigns and content",
"external_workspace_id": "fygr_123",
"created_at": "2024-01-05T08:00:00Z",
"updated_at": "2024-01-18T12:15: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"
}
}Headers
Bearer token for authentication
Body
multipart/form-dataapplication/json
Image in png, jpg or svg format
Resource type identifier
Allowed value:
"media"Type of media (avatar, logo, banner)
Available options:
avatar, logo, banner Marks preferred media. Default: true
Type for people relationship
Allowed value:
"people"UUID of the person to associate with this media
Type for company relationship
Allowed value:
"company"UUID of the company to associate with this media
Type for workspace relationship
Allowed value:
"workspace"UUID of the workspace to associate with this media
UUID of the external workspace to associate with this media
Response
Media created successfully
Show child attributes
Show child attributes
⌘I