Uploads one private file to a conversation as multipart/form-data using the file field.
/api/conversations/{conversationId}/attachmentsUploads one private file to a conversation as multipart/form-data using the file field. The server enforces the 12 MiB request limit, validates the media type, stores the object privately, and returns attachment metadata with a short-lived signed download URL. A visitor bearer token may upload only to its own conversation; organization API keys may upload only within their organization. Do not persist the signed URL; request a fresh attachment or access URL when it expires. Upload scanning and storage failures return an error without publishing a usable attachment.
Bearer API key or X-API-Key header.conversations:writeautomation_api)Resource identifier.
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"id": "66666666-6666-4666-8666-666666666666",
"attachmentId": "66666666-6666-4666-8666-666666666666",
"filename": "invoice-2026.pdf",
"originalName": "invoice-2026.pdf",
"mimeType": "application/pdf",
"size": 18432,
"url": "https://files.example.invalid/private/signed-download"
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request POST \
'https://api.convor.io/api/conversations/22222222-2222-4222-8222-222222222222/attachments' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--form 'file=@/path/to/example.txt'const formData = new FormData();
formData.append("file", new File(["replace-with-file-bytes"], "example.txt", {type: "text/plain"}));
const response = await fetch("https://api.convor.io/api/conversations/22222222-2222-4222-8222-222222222222/attachments", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
body: formData,
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?
Value of file.