API reference descriptions are provided in English to preserve the exact published contract.
GET /v1/accounts/{AC}/media
Required scope: `media:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | query · integer (1–100) | ||
cursor | query · string (max 2048 chars) | ||
AC | path · string (AC… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/media
Upload a file (multipart) or have Ship Messages fetch one from a URL. Use the returned media SID in a message. Files are scanned before they can be sent. Required scope: `media:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
declaredMime | string (max 255 chars) | ||
filename | string | ||
type | "AUTO" | "IMAGE" | "AUDIO" | "VIDEO" | "DOCUMENT" | "STICKER" | ||
url | string (max 4096 chars) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
POST /v1/accounts/{AC}/media/uploads
Required scope: `media:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes |
| Name | Type | Required | Description |
|---|---|---|---|
mediaSid | string (ME… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/media/{ME}
Fetch a media object's type, size, scan result and expiry. Required scope: `media:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | |
ME | path · string (ME… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
DELETE /v1/accounts/{AC}/media/{ME}
Required scope: `media:write`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | |
ME | path · string (ME… SID) | yes |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.