SahaSSBio · Developer resources

SSBio Research API

A shared API for SSBio Lab research software.

Checking server status · documentation available

SSBio Research API

Choose a tool to open its written guide, examples and limits. CatRange predicts enzyme–substrate kinetic ranges. CatShift explores candidate variants with predicted kinetic shifts.

Get started

  1. Get an API key by email. The same emailed key works with both tools; existing active keys keep their value.
  2. Open the CatRange written guide or CatShift written guide for its input formats and runnable examples.
  3. Check server status, then submit to the versioned API for your chosen tool. Each guide links to its interactive reference.

One account, shared resources

Use Authorization: Bearer YOUR_API_KEY for job requests. Keep your key private; never put it in browser JavaScript or a public repository. Operator-issued keys may have narrower tool permissions.

Default emailed keys allow 120 authenticated requests per minute and 10 new submission attempts per UTC day, shared across both tools. The hosted queue currently permits up to five running workers and five unfinished jobs in total, shared with the websites. Live availability can change.

Use a saved Idempotency-Key for each submission and reuse it with unchanged inputs if that request needs a retry. Both written guides explain safe retries, progress, result downloads, retention and scientific interpretation.

API reference or written guide?

The written guides explain how to prepare inputs and use each tool: CatRange guide and CatShift guide.

The interactive references let you inspect endpoints and try requests with your key: CatRange reference (live API) and CatShift reference (live API). OpenAPI schemas provide machine-readable contracts.

CatShift remains under development. For now, please cite CatRange when using CatShift results.