Learn how to interact with OMatG API 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.
Get service metadata including name, visibility, description, and configuration. You can retrieve by service ID or identifier.
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"))
# Option 1: Retrieve by service ID
service_id = "fa212d98-e73b-4c84-87d9-f9e4a8d3b8d6"
service = ouro.services.retrieve(service_id)
# Option 2: Retrieve by service identifier (username/service-name)
service_identifier = "mmoderwell/omatg-api"
service = ouro.services.retrieve(service_identifier)
print(service.name, service.visibility)
print(service.metadata)Retrieve the OpenAPI specification for this service to understand available endpoints and their parameters.
# Retrieve the service
service = ouro.services.retrieve("mmoderwell/omatg-api")
# Read the OpenAPI spec
spec = ouro.services.read_spec(service.id)
print(spec.get("openapi"))
print(spec.get("info"))Get all routes for this service and use them programmatically.
# Retrieve the service
service = ouro.services.retrieve("mmoderwell/omatg-api")
# Get all routes for this service
routes = ouro.services.read_routes(service.id)
for route in routes:
print(f"{route.route.method} {route.route.path}")
print(f" Summary: {route.route.summary}")Click on an endpoint to view its detailed documentation.
No compatible actions for services yet
OMatG is a generative model for crystal structure prediction (CSP) and de novo generation of inorganic materials.