Product / SDK and API
SDK and API
One typed API with a published schema, a Python SDK and a command line — the browser uses the same API, so everything it does can be scripted.
For scientists who compute in Python and developers who build on the platform.
- Available Python SDK, command line and templates
- Available One typed API
- Available Everything the browser does is scriptable
Key features
- Exact reads
- Read the version you name, with its axis, units and missing values as stored.
- Browser sign-in
- Approve a Python sign-in in the Workspace once; no password in your script.
- Publish with inputs
- A result records the exact versions and parameters it came from.
- Recover a lost answer
- Repeating a publication returns the same result; nothing is published twice.
- Generated types
- Python and TypeScript types generated from the one OpenAPI document.
- Templates
- Notebook, script, application and agent templates with a synthetic mode.
How it works
- Sign in from Python; approve the request in the Workspace.
- Read exact versions into your own code.
- Publish the result; share it when you are ready.
Technical details
The SDK is a 0.x preview. Uploads are limited by each deployment (at most 32 MiB per file); the refusal names the limit.
Not yet, and not planned
- Python SDK, command line and templates: Preview (0.x) release; Windows is not yet qualified
Not planned: suite-wide petrel or techlog replacement; a general application builder or marketplace; universal format conversion.