Join for freeSign in
4mo

Service Documentation

Learn how to interact with MatterGen using the Ouro SDK or REST API.

API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.

Getting Started

Use the Ouro SDK to retrieve service metadata and interact with the API programmatically.

import os
from ouro import Ouro
 
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
 
service_id = "4f0a3b52-e66e-4144-95b9-c7cf0a456470"
 
# Retrieve service metadata
s = ouro.services.retrieve(service_id)
print(s.name, s.visibility)
 
# Optionally read the OpenAPI spec
spec = ouro.services.read_spec(service_id)
print(spec.get("openapi"))

OpenAPI Specification

Download the complete OpenAPI spec for this service.

Download Spec

Available Endpoints

POST
/mattergen/generate/magnetic-density-hhi-score

Generate crystal structures with magnetic density and HHI score conditioning

POST
/mattergen/generate/single

Generate a crystal structure with MatterGen

POST
/mattergen/generate/magnetic-density

Generate crystal structures with magnetic density conditioning

POST
/mattergen/generate

Generate crystal structures

GET
/mattergen

Welcome