Join for freeSign in
6mo

API key required. Sign up for an Ouro account and create an API key to get started.

  • POST /structure/supercell

    Create a supercell from a material

    Request body

    file

    objectRequired

    id

    url

    stringRequired

    name

    type

    stringRequired

    org_id

    stringRequired

    team_id

    stringRequired

    filename

    stringRequired

    visibility

    stringRequired

    description

    size

    stringDefaults to 2x2x2
      2x2x23x3x34x4x4

    Predefined supercell size option

    symprec

    numberDefaults to 0.1

    Symmetry precision for structure analysis

    angle_tolerance

    numberDefaults to 5

    Angle tolerance for symmetry finding in degrees (°)

    preserve_symmetry

    booleanDefaults to true

    Whether to preserve symmetry operations in supercell

    const url = 'https://api.ouro.foundation/routes/hermes/structure/supercell';
const options = {
  method: 'POST',
  headers: {
    'Authorization': 'ApiKey {your-ouro-api-key}',
    'Content-Type': 'application/json'
  }
};
 
const payload = {
  "file": {
    "url": "example_string",
    "type": "example_string",
    "org_id": "example_string",
    "team_id": "example_string",
    "filename": "example_string",
    "visibility": "example_string"
  },
  "size": "2x2x2",
  "symprec": 0.1,
  "angle_tolerance": 5,
  "preserve_symmetry": true
};
options.body = JSON.stringify(payload);
 
fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));