Skip to main content
POST
/
v1
/
media
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/media \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form platform=whatsapp
{
  "id": "<string>",
  "fileName": "<string>",
  "mimeType": "<string>",
  "fileSize": 123,
  "mediaType": "image",
  "url": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "urlExpiresIn": 123
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Body

multipart/form-data
​
file
file
required

The media file to upload

​
platform
enum<string>

Target platform for validation (optional)

Available options:
whatsapp,
sms,
mms

Response

Media uploaded successfully

​
id
string
required

Unique media ID

​
fileName
string
required

Original file name

​
mimeType
string
required

MIME type of the file

​
fileSize
number
required

File size in bytes

​
mediaType
enum<string>
required

Type of media

Available options:
image,
video,
audio,
document,
sticker
​
url
string<uri>
required

Presigned URL for downloading (expires in 1 hour)

​
expiresAt
string<date-time>
required

When the media will be deleted

​
createdAt
string<date-time>
required

When the media was uploaded

​
urlExpiresIn
number
required

URL expiration time in seconds