Skip to content

atomgptlab/agapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌐 AtomGPT.org API (AGAPI)

AGAPI provides a simple way to interact with AtomGPT.org, enabling Agentic AI materials science research through intuitive APIs.

A significant amount of time in computational materials design is often spent on software installation and setup — a major barrier for newcomers.

AGAPI removes this hurdle by offering APIs for prediction, analysis, and exploration directly through natural language or Python interfaces, lowering entry barriers and accelerating research.


📖 Table of Contents


🧠 Capabilities & Example Prompts

AGAPI supports natural language interaction for a wide range of materials science tasks.
Each section below includes a prompt example and expected output.


1️⃣ Access Materials Databases

Prompt:

List materials with Ga and As in JARVIS-DFT

Response:
Displays all GaAs-containing entries from the JARVIS-DFT database.

Database example


2️⃣ Graph Neural Network Property Prediction (ALIGNN)

Prompt:

Predict properties of this POSCAR using ALIGNN

(Upload a POSCAR, e.g. example POSCAR file)

Response:
Returns AI-predicted material properties (formation energy, bandgap, etc.).

ALIGNN prediction


3️⃣ Graph Neural Network Force Field (ALIGNN-FF)

Prompt:

Optimize structure from uploaded POSCAR file using ALIGNN-FF

(Upload a POSCAR, e.g. example file)

Response:
Generates optimized structure and energy data.

ALIGNN-FF example


4️⃣ X-ray Diffraction → Atomic Structure

Prompt:

Convert XRD pattern to POSCAR

(Upload an XRD file, e.g. example XRD file)

Response:
Predicts atomic structure that best matches the uploaded diffraction pattern.

XRD to structure


5️⃣ Live arXiv Search

Prompt:

Find papers on MgB₂ in arXiv. State how many results you found and show top 10 recent papers.

Response:
Summarizes and lists the latest publications from arXiv related to MgB₂.

arXiv search example


6️⃣ Web Search

Prompt:

Search for recent advances in 2D ferroelectric materials.

Response:
Fetches and summarizes up-to-date information from web sources on the requested topic.


7️⃣ Visualize Atomic Structures

Prompt:

Visualize the crystal structure of Silicon in 3D.

Response:
Generates a 3D interactive visualization of the given structure (CIF or POSCAR).


8️⃣ General Question Answering

Prompt:

Explain the difference between DFT and DFTB.

Response:
Provides a concise explanation with context and examples.


9️⃣ Structure Manipulation

Prompt:

Replace oxygen atoms with sulfur in this POSCAR.

Response:
Outputs a modified POSCAR file with requested atomic substitutions.


🔟 Voice Chat Interaction

Prompt (spoken):

What is the bandgap of silicon?

Response (spoken):

The bandgap of silicon is approximately 1.1 eV.

Enables voice-based chat for hands-free interaction with materials science tools.


🚀 Quickstart

Colab Notebook

Try AGAPI instantly in Google Colab:
👉 AGAPI Example Notebook

Python SDK

For detailed SDK usage:
👉 agapi/README.md


🎥 YouTube Demos

Watch AGAPI in action on YouTube:
🎬 AGAPI Demo Playlist


📚 References

  1. Choudhary, K. et al., IMMI. 2025.
  2. Choudhary, K. et al., Comput. Mater. Sci. 2025.
  3. Choudhary, K. et al., J. Phys. Chem. Lett. 2024.

❤️ Note

“AGAPI (ἀγάπη)” is a Greek word meaning unconditional love.

DISCLAIMER

AtomGPT.org can make mistakes. Please verify important information.

We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Poster

About

AtomGPT.org API Usage Examples

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages