Skip to Content

Get a media object

Returns the media object's metadata, including status, dimensions, and confirmation timestamps.

GET
/v1/media/{id}

Returns the media object's metadata, including status, dimensions, and confirmation timestamps.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^media_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

Media

application/json
  1. response
id*MediaId
Match^media_[0-9a-hjkmnp-tv-z]{16,24}$
organizationId*OrganizationId
Match^org_[0-9a-hjkmnp-tv-z]{16,24}$
status*string
Value in"pending""uploading""processing""ready""failed""deleted"
filename*string
contentType*string
sizeBytes*number
Range0 <= value
width*|null
height*|null
durationMs*|null
purpose*string
Value in"attachment""avatar""whatsapp_media""review_evidence"
checksumSha256*string|null
expiresAt*string|null
createdAt*string
confirmedAt*string|null
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.media.getById({
  "id": "example"
});
Example Response
{
  "id": "string",
  "organizationId": "string",
  "status": "pending",
  "filename": "string",
  "contentType": "string",
  "sizeBytes": 0,
  "width": 1,
  "height": 1,
  "durationMs": 0,
  "purpose": "attachment",
  "checksumSha256": "string",
  "expiresAt": "string",
  "createdAt": "string",
  "confirmedAt": "string"
}

Related documentation