Images

How to Generate Markdown for Images

Make a POST request to the /v2/markdown-converter/ endpoint with the required parameters in the body and make sure you use the image type.

To use the image type, the resource should be provided as URLs.

Request Example (File Path)

from wetro import Wetrocloud
    
# Initialize the Wetrocloud client
client = Wetrocloud(api_key="your_api_key")
    
# Generate Markdown
markdown_response = client.markdown_converter(
  link = "./image/zy69smzbjqtogtjlszki.jpg", # Replace with your actual file path
  resource_type = "image"
)

print(markdown_response)

import Wetrocloud from "wetro-sdk";

// Initialize the Wetrocloud client
const client = new Wetrocloud({
  apiKey: "your_api_key"
});

// Generate Markdown
const response = await client.markDownConverter({
  resource: "./image/zy69smzbjqtogtjlszki.jpg", // Replace with your actual file path
  resource_type: "image"
});

console.log("converted to markdown", response);

curl --request POST \
  --url https://api.wetrocloud.com/v2/markdown-converter/ \
  --header 'Authorization: Token <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    # File Paths are not accepted via cURL, therefore files must be provided as URL
    "resource": "https://res.cloudinary.com/dxcb59rb3/image/upload/v1747912102/zy69smzbjqtogtjlszki.jpg", 
    "type": "image"
  }'

Request Example (File as URL)

from wetro import Wetrocloud
    
# Initialize the Wetrocloud client
client = Wetrocloud(api_key="your_api_key")
    
# Generate Markdown
markdown_response = client.markdown_converter(
  link = "https://res.cloudinary.com/dxcb59rb3/image/upload/v1747912102/zy69smzbjqtogtjlszki.jpg",
  resource_type = "image"
)

print(markdown_response)

import Wetrocloud from "wetro-sdk";

// Initialize the Wetrocloud client
const client = new Wetrocloud({
  apiKey: "your_api_key"
});

// Insert a file into a Collection
const response = await client.markDownConverter({
  resource: "https://res.cloudinary.com/dxcb59rb3/image/upload/v1747912102/zy69smzbjqtogtjlszki.jpg", 
  resource_type:"image"
});

console.log("converted to markdown", response);

curl --request POST \
  --url https://api.wetrocloud.com/v2/markdown-converter/ \
  --header 'Authorization: Token <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "resource": "https://res.cloudinary.com/dxcb59rb3/image/upload/v1747912102/zy69smzbjqtogtjlszki.jpg", 
    "type": "image"
  }'

Successful Response

A successful response confirms the operation and tracks token usage. Example Response

  {
      response: 'Certainly! Here is the extracted information from the image:\n\n---\n\n
      ### Summary of the Month (28/04/2025)
      \n\n- Activities carried out:
      \n  - Automation of the loan allocation process
      \n  - Business process automation of the compassionate loan process
      \n  - Attendance/representation at the SPE FORUM
      \n  - Field and office business process automation
      \n  - Car and compassionate loan demos
      \n  - Development of the car/compassionate loan team calculator tool
      \n\n- Challenges and solutions:
      \n  - Technical problems involved in building the application.
      \n\n- Additional notes:\n  - Automatic formatting (related to figures/calculations).
      \n\n- Calculations:\n  - \\( 8,000,000 \\times 4 = 12 \\,(10,000) \\)
      \n  - \\( 3,400,000 - 120,000 \\)\n  - \\( 3,200,000 - 120,000 \\)
      \n\n- Amounts mentioned:\n  - 4,000,000\n  - 10,000\n  - 120,000',
      tokens: 946,
      success: true
    }

Field	Description
`success`	Indicates whether the resource was inserted successfully.
`tokens`	Number of tokens consumed during the operation.
`response`	Result for the markdown generation

Create Collection: Start by creating a collection to hold your resources.
Query Resources: Access and retrieve insights from the indexed resources.
Delete Collection: Remove collections and their resources when no longer needed.

Get Started

Data Extraction API

How to Generate Markdown for Images

Request Example (File Path)

Request Example (File as URL)

Successful Response

​How to Generate Markdown for Images

​Request Example (File Path)

​Request Example (File as URL)

​Successful Response

​Related Operations

How to Generate Markdown for Images

Request Example (File Path)

Request Example (File as URL)

Successful Response

Related Operations