Media as base64

GET

api

chat

base64

:instance

Media as base64

curl --request GET \
  --url https://api.example.com/api/chat/base64/:instance

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

Description

Reads media already stored locally (after ingestion) and returns the content in base64. Works for images, videos, audio, documents, and stickers.

Only messages whose media has already been downloaded and persisted by the ingestion pipeline return data here. If the media does not yet exist in storage, the response is 404.

Example

curl -X GET "https://ryzeapi.cloud/api/chat/base64/$Instance_Name?messageId=3EB08FCF27E532F1B0F5" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/chat/base64/${process.env.Instance_Name}?messageId=3EB08FCF27E532F1B0F5`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/chat/base64/{os.environ['Instance_Name']}?messageId=3EB08FCF27E532F1B0F5",
    headers={"token": os.environ["Token_Instance"]}
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/chat/base64/"+os.Getenv("Instance_Name")+"?messageId=3EB08FCF27E532F1B0F5", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Success response

The response echoes message_id, brings mime_type and media_type (general category: image, video, audio, document, sticker), and returns in base64 the raw media bytes already encoded, ready to write to a file, upload elsewhere, or display inline. The payload can be large for long videos/audios.

200 OK

{
  "success": true,
  "message": "Base64 retrieved successfully",
  "message_id": "3EB08FCF27E532F1B0F5",
  "mime_type": "image/jpeg",
  "media_type": "image",
  "base64": "iVBORw0KGgoAAAANSUhEUgAAAAEA..."
}

Path parameters

string

required

Instance name.

Query params

string

required

ID of the message that contains the media.

Headers

Name	Required	Example	Description
`token`	yes (or `Authorization`)	`a1b2c3d4-...`	TokenAccount or TokenInstance.

Error responses

HTTP	`error.message`	When it happens
400	`Instance name is required`	,
400	`messageId query parameter is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
404	`Message not found or no media available`	Media missing or not yet downloaded.
503	`Instance is not connected to WhatsApp`	,

Error 404

{
  "success": false,
  "error": { "message": "Message not found or no media available" }
}

Find message

Retrieve metadata before downloading.

Delivery status

Check delivery/read.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Media as base64

Description

Example

Success response

Path parameters

Query params

Headers

Error responses

Find message

Delivery status

​Description

​Example

​Success response

​Path parameters

​Query params

​Headers

​Error responses

​Related

Find message

Delivery status

Description

Example

Success response

Path parameters

Query params

Headers

Error responses

Related