Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Latest commit

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

🌐 AtomGPT.org API (AGAPI): Agentic AI for Materials Science

Open in Google ColabPyPILicense

Empower your materials science research with AtomGPT's Agentic AI API (AGAPI). AGAPI removes complex software setups, commercial API cost allowing you to perform advanced predictions, analyses, and explorations through natural language or Python, accelerating materials discovery and design. AGAPI implements a modular architecture separating the reasoning layer (LLM brain) from the execution layer (scientific tools and databases as hands) through a unified REST API interface. This design follows established principles of agentic AI systems.

🚀 Quickstart

1. Get your API key — sign up at AtomGPT.org → Account → Settings, then:

pip install agapi jarvis-tools scipy httpx
export AGAPI_KEY="sk-your-key-here"

2. Initialize client and agent:

importosfromagapi.agents.clientimportAGAPIClientfromagapi.agentsimportAGAPIAgentfromagapi.agents.functionsimport*fromjarvis.io.vasp.inputsimportPoscar# Direct function calls (API client)client=AGAPIClient(api_key=os.environ.get("AGAPI_KEY"))
result=query_by_formula("Si", client)
print(result["materials"][25]["formula"], result["materials"][25]["mbj_bandgap"])
# Natural language queries (AI agent)agent=AGAPIAgent(api_key=os.environ.get("AGAPI_KEY"))
response=agent.query_sync("What is the bandgap of Silicon?")
print(response)

✨ Key Capabilities

Common Inputs

SI_PRIM="""Si1.00 2.734 2.7342.734 0 2.7342.734 2.734 0Si2direct0 0 00.25 0.25 0.25"""GAAS_PRIM="""GaAs1.00 2.875 2.8752.875 0 2.8752.875 2.875 0Ga As1 1direct0 0 00.25 0.25 0.25"""SI_XRD="""28.44 1.0047.30 0.5556.12 0.30"""

1. Materials API Query

Access JARVIS-DFT and more.

API Example:

fromagapi.agents.functionsimport (
query_by_formula,
query_by_jid,
query_by_elements,
query_by_property,
find_extreme,
alignn_predict,
alignn_ff_relax,
slakonet_bandstructure,
generate_interface,
make_supercell,
substitute_atom,
create_vacancy,
generate_xrd_pattern,
protein_fold,
diffractgpt_predict,
alignn_ff_single_point,
alignn_ff_optimize,
alignn_ff_md,
pxrd_match,
xrd_analyze,
microscopygpt_analyze,
query_mp,
query_oqmd,
search_arxiv,
search_crossref,
openfold_predict,
list_jarvis_columns,
)
r=query_by_formula("Si", client)
assert"error"notinrr=query_by_jid("JVASP-1002", client)
assertisinstance(r.get("POSCAR"), str)
r=query_by_elements("Si", client)
assert"error"notinrr=query_by_property("bandgap", 0.1, 3.0, elements="Si", api_client=client)
assert"error"notinrr=find_extreme("bulk modulus", True, elements="Si", api_client=client)
assert"error"notinr

Natural Language Example:

agent.query_sync("Show me all MgB2 polymorphs")
agent.query_sync("What's the Tc_Supercon for MgB2 and what's the JARVIS-ID for it?")
agent.query_sync("What's the stiffest Si,O material?")
agent.query_sync("Find materials with bulk modulus > 200 GPa")
agent.query_sync("Compare bandgaps across BN, AlN, GaN, InN")
agent.query_sync("What are the formation energies of SiC, AlN, MgO?")

2. AI Property Prediction (ALIGNN)

Predict bandgap, formation energy, elastic moduli, and more using graph neural networks.

API Example:

fromagapi.agents.functionsimportalignn_predictr=alignn_predict(jid="JVASP-1002", api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Predict properties of JARVIS-ID JVASP-1002 with ALIGNN")
agent.query_sync(f"Predict properties using ALIGNN for this structure:\n\n{SI_PRIM}")

3. AI Force Field (ALIGNN-FF)

Structure relaxation, single-point energy, and MD with near-DFT accuracy.

API Example:

fromagapi.agents.functionsimportalignn_ff_relax, alignn_ff_single_pointr=alignn_ff_relax(SI_PRIM, api_client=client)
assertr.get("status") =="success"print(Poscar.from_string(r["relaxed_poscar"])) # view relaxed structurer=alignn_ff_single_point(SI_PRIM, api_client=client)
assert"energy_eV"inr

Natural Language Example:

agent.query_sync(f"Optimize structure with ALIGNN-FF:\n\n{SI_PRIM}")
agent.query_sync("Get the single-point energy of this Si primitive cell.")

4. Band Structure (SlakoNet)

Tight-binding band structures from neural network Slater-Koster parameters.

API Example:

fromagapi.agents.functionsimportslakonet_bandstructurer=slakonet_bandstructure(SI_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync("Compute the band structure of Si.")
agent.query_sync(f"Plot the electronic band structure for this POSCAR:\n\n{SI_PRIM}")

5. XRD / DiffractGPT

Match PXRD patterns, identify phases, and analyze experimental diffraction data.

API Example:

fromagapi.agents.functionsimportpxrd_match, xrd_analyze, diffractgpt_predictr=pxrd_match("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
if"matched_poscar"inr:
print(Poscar.from_string(r["matched_poscar"])) # view matched structurer=xrd_analyze("Si", SI_XRD, api_client=client)
assertisinstance(r, dict)
r=diffractgpt_predict("Si", "28.4(1.0),47.3(0.49)", client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Identify the phase from this XRD pattern for Silicon: [XRD data]")
agent.query_sync("Analyze this PXRD pattern and suggest possible structures.")

6. STEM / MicroscopyGPT

Analyze STEM, TEM, and electron microscopy images using AI — identify atomic columns, measure lattice spacings, detect defects, and interpret microstructure.

API Example:

fromagapi.agents.functionsimportmicroscopygpt_analyzer=microscopygpt_analyze("HRTEM image of Si lattice", api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Analyze this STEM image of a GaN thin film: [image]")
agent.query_sync("What defects are visible in this HRTEM image?")
agent.query_sync("Measure the d-spacing from this electron diffraction pattern.")

7. Structure Manipulation

Supercells, substitutions, vacancies, and XRD pattern generation — runs locally, no API call needed.

API Example:

fromagapi.agents.functionsimportmake_supercell, substitute_atom, create_vacancy, generate_xrd_patternr=make_supercell(SI_PRIM, [2, 2, 1])
assertr["supercell_atoms"] >r["original_atoms"]
print(f"Original atoms: {r['original_atoms']}, Supercell atoms: {r['supercell_atoms']}")
# Expected: Original atoms: 2, Supercell atoms: 8r=substitute_atom(GAAS_PRIM, "Ga", "Al", 1)
assert"Al"inr["new_formula"]
# Expected new_formula: AlAsr=create_vacancy(GAAS_PRIM, "Ga", 1)
assertr["new_atoms"] ==r["original_atoms"] -1# Expected: one fewer atom than originalr=generate_xrd_pattern(SI_PRIM)
assertr["formula"] =="Si"

Natural Language Example:

agent.query_sync("Make a 2x1x1 supercell of the most stable GaN.")
agent.query_sync("Substitute one Ga with Al in this GaAs structure.")
agent.query_sync("Create a Ga vacancy in GaAs and predict its properties.")

8. Interface Generation

Build heterostructure interfaces between two materials.

API Example:

fromagapi.agents.functionsimportgenerate_interfacer=generate_interface(SI_PRIM, GAAS_PRIM, api_client=client)
assertr.get("status") =="success"

Natural Language Example:

agent.query_sync(""" Create a GaN/AlN heterostructure interface: 1. Find GaN (most stable) 2. Find AlN (most stable) 3. Generate (001)/(001) interface 4. Show POSCAR""", max_context_messages=20)

9. Literature Search

Search arXiv and Crossref for relevant research papers.

API Example:

fromagapi.agents.functionsimportsearch_arxiv, search_crossrefr=search_arxiv("GaN", max_results=2, api_client=client)
assertisinstance(r, dict)
r=search_crossref("GaN", rows=2, api_client=client)
assertisinstance(r, dict)

Natural Language Example:

agent.query_sync("Find recent papers on perovskite solar cells on arXiv.")
agent.query_sync("Search for publications about ALIGNN neural networks.")

🔧 Multi-Step Agentic Workflow

agent.query_sync("""1. Find all GaN materials in the JARVIS-DFT database2. Get the POSCAR for the most stable one3. Make a 2x1x1 supercell4. Substitute one Ga with Al5. Generate powder XRD pattern6. Optimize structure with ALIGNN-FF7. Predict properties with ALIGNN""", max_context_messages=20, verbose=True)
agent.query_sync("""Create a GaN/AlN heterostructure interface:1. Find GaN (most stable)2. Find AlN (most stable)3. Generate (001)/(001) interface4. Show POSCAR""", max_context_messages=20, verbose=True)

🤖 Supported LLM Backends

AGAPI supports multiple LLM backends. Set model when initializing the agent:

agent=AGAPIAgent(
api_key=os.environ.get("AGAPI_KEY"),
model="openai/gpt-oss-20b" )

Available models:

ProviderModel
OpenAIopenai/gpt-oss-20b
OpenAIopenai/gpt-oss-120b
Metameta/llama-4-maverick-17b-128e-instruct
Metameta/llama-3.2-90b-vision-instruct
Metameta/llama-3.2-1b-instruct
Googlegoogle/gemini-2.5-flash
Googlegoogle/gemma-3-27b-it
DeepSeekdeepseek-ai/deepseek-v3.1
Moonshotmoonshotai/kimi-k2-instruct-0905
Qwenqwen/qwen3-next-80b-a3b-instruct

📦 Available APIs/Functions

FunctionDescription
query_by_formulaSearch by chemical formula
query_by_jidFetch by JARVIS ID
query_by_elementsFilter by constituent elements
query_by_propertyFilter by property range
find_extremeFind max/min property material
alignn_predictGNN property prediction
alignn_ff_relaxStructure relaxation
alignn_ff_single_pointSingle-point energy
slakonet_bandstructureTB band structure
generate_interfaceHeterostructure builder
make_supercellSupercell generation
substitute_atomAtomic substitution
create_vacancyVacancy creation
generate_xrd_patternSimulated XRD
pxrd_match / xrd_analyzeXRD phase matching
diffractgpt_predictAI XRD interpretation
microscopygpt_analyzeAI STEM/TEM image analysis
query_mpMaterials Project query
search_arxiv / search_crossrefLiterature search
protein_foldProtein structure prediction

...

📖 References

If you find this work helpful, please cite:

  1. AGAPI-Agents: An Open-Access Agentic AI Platform for Accelerated Materials Design on AtomGPT.orghttps://doi.org/10.48550/arXiv.2512.11935

  2. ChatGPT Material Explorer: Design and Implementation of a Custom GPT Assistant for Materials Science Applicationshttps://doi.org/10.1016/j.commatsci.2025.114063

  3. The JARVIS Infrastructure Is All You Need for Materials Designhttps://doi.org/10.1016/j.commatsci.2025.114063

📄 Full publication list: Google Scholar


📚 Resources


❤️ Note

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

Disclaimer

AtomGPT.org can make mistakes — please verify critical results. We hope this API fosters open, collaborative, and accelerated discovery in materials science.

Releases

Packages

Used by

Contributors

Languages