SupportDashboard
DocsAPI Reference
  • API Reference
    • GETGet RCS functionality
    • Upload
    • Receive Inbound Messages
    • Receive Message Statuses
    • Supported SDKs
    • Branded Test Agents
LogoLogo
SupportDashboard
API ReferenceTools

POST
https://www.trypinnacle.dev/api/tools/uploadUrl
POST
/api/tools/uploadUrl
1import { PinnacleClient } from "rcs-js";
2
3async function main() {
4    const client = new PinnacleClient({
5        environment: "https://www.trypinnacle.dev/api",
6    });
7    await client.tools.uploadUrl({});
8}
9main();
Try it
1{
2  "upload": "https://server.trypinnacle.app/storage/v1/object/upload/sign/assets/example.png",
3  "download": "https://server.trypinnacle.app/storage/v1/object/sign/assets/example.png"
4}
Was this page helpful?
Previous

Upload local files

Upload local files to Pinnacle to send as messages.
Next
Built with

Generate signed upload (expires in 2 hours) and download URLs for a file (expires in 1 hour).

See the Upload page for native Python and Typescript SDKs.

Create Upload URL

Headers

PINNACLE-API-KeystringRequired

Request

JSON payload containing the file metadata.
contentTypestringRequired
The MIME type of the file. Supported types are audio/basic, audio/L24, audio/mp4, audio/mpeg, audio/mpg, audio/mp3, audio/ogg, audio/aac, audio/vndrn-realaudio, audio/vndwave, audio/3gpp, audio/3gpp2, audio/ac3, audio/webm, audio/amrnb, audio/amr, video/mpeg, video/mp4, video/quicktime, video/webm, video/3gpp, video/3gpp2, video/3gpptt, video/H261, video/H263, video/H2631998, video/H2632000, video/H264, video/m4v, video/mpeg4, video/webm, image/jpeg, image/gif, image/png, image/gif, image/bmp, image/tiff, image/webp, text/vcard, text/xvcard, text/csv, text/rtf, text/richtext, text/calendar, text/directory, application/ogg, application/pdf, application/vcard, application/vndapple.pkpass.
sizeintegerRequired
The size of the file in bytes. Should be less than 100 MB.
namestringRequired
The name of the file.

Response

Successfully generated upload and download URLs
uploadstring or null
The URL to upload the file.
downloadstring or null
The URL to download the file.

Errors

The size of the file in bytes. Should be less than 100 MB.
The name of the file.
Successfully generated upload and download URLs

The MIME type of the file.

Supported types are audio/basic, audio/L24, audio/mp4, audio/mpeg, audio/mpg, audio/mp3, audio/ogg, audio/aac, audio/vndrn-realaudio, audio/vndwave, audio/3gpp, audio/3gpp2, audio/ac3, audio/webm, audio/amrnb, audio/amr, video/mpeg, video/mp4, video/quicktime, video/webm, video/3gpp, video/3gpp2, video/3gpptt, video/H261, video/H263, video/H2631998, video/H2632000, video/H264, video/m4v, video/mpeg4, video/webm, image/jpeg, image/gif, image/png, image/gif, image/bmp, image/tiff, image/webp, text/vcard, text/xvcard, text/csv, text/rtf, text/richtext, text/calendar, text/directory, application/ogg, application/pdf, application/vcard, application/vndapple.pkpass.