Upload message images
POST
/v1/messages/upload-image
multipart/form-data under the images field.How to use it: Send a POST request to
/v1/messages/upload-image with the request body, query parameters, or multipart fields shown below. Authorization: Bearer <apiKey>. Community API keys require the matching messaging permission. User API keys can also be used for supported message actions and may be channel-restricted.Required permission:
sendMessage or user permission sendMessages.Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under
data with status and message.Common error states:
400 invalid request body, query, ObjectId, pagination, file format, or missing required field.401 missing, invalid, expired, or insufficient API key/token.403 key is valid but cannot access this community/channel/user/resource, where supported by the service.404 target resource, route, or community-scoped record was not found.409 duplicate or conflicting state for create/update operations, where applicable.500 unexpected Returning.AI service error.Request
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v1/messages/upload-image' \
--form 'images=@""'Response Response Example
200 - Example 1
[
{
"id": "string",
"name": "string",
"url": "string",
"type": "string",
"size": 0
}
]Modified at 2026-05-18 17:03:37