3mo

Service Documentation

Learn how to interact with Crystal Generator 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 = "2954242f-68b1-4029-a583-ed1b2bf3e1fc"
 
# 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

GET

/crystal-gen

Root

POST

/crystal-gen/generate

Generate a crystal structure using GGen

POST

/crystal-gen/describe

Get a detailed description of a crystal structure

POST

/crystal-gen/create-cif

Generate CIF file from crystal structure description

GET

/crystal-gen/compatible-space-groups

Get space groups compatible with a given chemical formula