API reference
Every endpoint, with its parameters, a Python and a curl example, and the response it returns.
Base URL https://api.kaimei.ai. Authenticate every request with Authorization: Bearer km_live_…; see Authentication. Requests and responses are JSON, lists page with limit and offset, and every error shares one envelope; see pagination and Errors. Python examples use a client constructed as client = Kaimei(), which reads KAIMEI_API_KEY from the environment.
Register, update, version and run models, and manage the reference data they are explained against.
- GETList models
- POSTRegister a model
- GETRetrieve a model
- PATCHUpdate a model
- DELETEDelete a model
- GETList versions
- POSTCreate a version
- DELETEDelete a version
- POSTTransfer a model
- POSTFork a model
- PUTUpload reference data
- GETRetrieve the reference data summary
- DELETEClear reference data
- POSTPredict through Kaimei
- GETModel statistics
- GETModel performance
Upload a model's layers and weights, read them back, replay a prediction through them and see what every layer computes.
Log the predictions your models make, or read back the ones Kaimei made, for explanation and monitoring.
Attributions for one input: why the model produced this output, and the smallest change that would flip it.
Background studies of a whole model that write insights: importance, behaviour, interactions, robustness, drift, rules and performance.
The findings analyses write about a model, each with a summary, a severity and the numbers behind it.
Group models into projects and read the roll-ups across them: traffic, alerts and the inputs each model relies on.
Personal workspaces and organizations: who is in them, what each role may do, invitations, and the plan, quotas and overview of the one you are working in.
- GETList your organizations
- POSTCreate an organization
- GETRetrieve the organization
- PATCHUpdate the organization
- DELETEDelete the organization
- GETWorkspace overview
- GETList members
- PATCHChange a member's role
- DELETERemove a member, or leave
- POSTInvite someone
- GETList invitations sent
- POSTSend an invitation again
- DELETEWithdraw an invitation
- GETInvitations waiting for you
- POSTLook at an invitation link
- POSTAccept an invitation
- POSTDecline an invitation
The plan a workspace is on, paying for it through Stripe, and what the Team plan unlocks for an organization.
Create, list and revoke the credentials your servers and notebooks use.
Sign-up, sign-in and profile endpoints for dashboard users and for front ends built on the API.
- GETSign-in methods
- POSTCreate an account
- POSTSign in
- POSTSwitch organization
- GETWho am I
- PATCHUpdate the profile
- POSTUpload or remove a profile photo
- DELETERemove a profile photo
- POSTVerify an email address
- GETOpen a verification link
- POSTResend a verification email
- POSTRequest a password reset
- POSTChoose a new password
- GETOAuth sign-in
- GETOAuth callback
- POSTSign out