🧪 CMPDIMG API Documentation

Welcome to CMPDIMG - a service for converting SMILES (Simplified Molecular Input Line Entry System) strings into molecular structure images. This service is designed for easy integration into web pages, Excel spreadsheets, and other applications.

📋 Quick Start

Basic Usage:

GET /generate?smiles=CCO

This returns a PNG image of ethanol (CCO).

🔧 API Endpoints

Generate Image: `GET /generate`

Convert a SMILES string to a molecular structure image.

Parameter	Type	Required	Default	Description
`smiles`	string	✅ Yes	-	SMILES string representing the molecule
`format`	string	❌ No	png	Output format: `png` or `svg`
`width`	integer	❌ No	300	Image width in pixels (50-2000)
`height`	❌ No	integer	300	Image height in pixels (50-2000)
`transparent`	boolean	❌ No	true	Use transparent background (PNG only)

Health Check: `GET /health`

Simple health check endpoint that returns service status.

Status: `GET /status`

Detailed status information including version and environment.

Help: `GET /help`

This documentation page.

API Documentation: `GET /docs`

Interactive OpenAPI/Swagger documentation.

🌐 Using in Web Pages

Simple Image Tag

<img src="https://cmpdimg.montai.net/generate?smiles=CCO"
     alt="Ethanol" />

With Custom Dimensions

<img src="https://cmpdimg.montai.net/generate?smiles=c1ccccc1&width=400&height=400"
     alt="Benzene"
     width="400"
     height="400" />

SVG Format

<img src="https://cmpdimg.montai.net/generate?smiles=CC(=O)O&format=svg"
     alt="Acetic Acid" />

Dynamic JavaScript Example

const smiles = "CCO";
const img = document.createElement('img');
img.src = `https://cmpdimg.montai.net/generate?smiles=${encodeURIComponent(smiles)}`;
img.alt = smiles;
document.body.appendChild(img);

📊 Using in Excel

Excel IMAGE Function (Office 365/2021+)

If your SMILES string is in cell A1:

=IMAGE("https://cmpdimg.montai.net/generate?smiles="&A1)

With custom size:

=IMAGE("https://cmpdimg.montai.net/generate?smiles="&A1&"&width=250&height=250")

Excel Web Add-in (Older versions)

Note: For Excel versions that don't support the IMAGE function, you can use web-based add-ins or macros to insert images from URLs.

📝 Example SMILES Strings

Valid Examples

SMILES	Molecule	Try It
`CCO`	Ethanol	View
`c1ccccc1`	Benzene	View
`CC(=O)O`	Acetic Acid	View
`CC(C)O`	Isopropanol	View
`C1=CC=C(C=C1)O`	Phenol	View
`CC(=O)Oc1ccccc1C(=O)O`	Aspirin	View

⚠️ Error Handling

If an invalid SMILES string is provided, the API will return:

HTTP Status: 400 Bad Request
An error image showing the problem
JSON error details in the response headers

Invalid SMILES Examples:

INVALID - Not a valid SMILES syntax
C[C@ - Incomplete SMILES string
xxx123 - Invalid characters/structure

🔗 CURL Examples

Save PNG to File

curl "https://cmpdimg.montai.net/generate?smiles=CCO" -o ethanol.png

Save SVG to File

curl "https://cmpdimg.montai.net/generate?smiles=c1ccccc1&format=svg" -o benzene.svg

Custom Dimensions

curl "https://cmpdimg.montai.net/generate?smiles=CC(=O)O&width=500&height=500" -o acetic_acid.png

🚀 Rate Limits & Best Practices

No authentication required - service is publicly accessible
Please be considerate with request volume
Cache images when possible to reduce redundant requests
Use appropriate image sizes for your use case
Always URL-encode SMILES strings in URLs

🛠️ Environments

Environment	URL	Purpose
Production	`https://cmpdimg.montai.net`	Stable production service
Test	`https://cmpdimg-test.montai.net`	Testing and validation

📚 Additional Resources

💡 Support

For issues, questions, or feature requests, please contact your system administrator or check the project repository.