Skip to the endpoints
StructSubAPI
REFERENCE

Every endpoint,
with a console attached.

Upload a structure once, then work within its session: select atoms, substitute fragments, optimise, analyse and export. Each endpoint below expands to its exact request body, its response, and a Try it out button that calls this server.

Start from the Python quickstart How sessions work
BASE URL

This server

Every path below is relative to the address in your browser's bar. Use that same address in your scripts.

AUTHENTICATION

Account access

Anonymous uploads need no sign-in. Account operations use a short-lived token from sign-in as Authorization: Bearer …. There are no personal API keys — see API access & keys.

SESSIONS

Upload once

POST /sessions returns a session ID. Put it in the path of everything after that, and the server keeps your structure and its edit history.

LONG WORK

Some calls queue

A response with queued: true carries a job ID. Poll /jobs/{job_id} until it reports done, failed or cancelled.

A completed calculation is not necessarily a converged one. Optimisation responses carry report.converged, max_force and any warnings. Read them before using the geometry — the request succeeding only means the calculation ran.