Skip to content

CoCalc Python API Client

Install the Python client API cocalc-api that is hosted on Pypi.

pip install cocalc-api

Obtain a CoCalc account API Key by going to your account preferences and scrolling down to "Api Keys", then start using CoCalc from your Python scripts. This API is mostly for account level API keys, but it also provides some minimal support for project specific API keys.

Using an account level API key, the cocalc_api Python library enabled you to do all of the following very easily from a Python script:

  • search for other cocalc users by name or email address, and get the name associated to an account_id
  • list your projects, add and remove collaborators, copy files between projects and start, stop and create projects.
  • use the Jupyter API to evaluate code using a kernel, either in an anonymous sandbox or in one of your projects.
  • read or write any data you have access to in the CoCalc PostgreSQL database, as defined by this schema.
  • instantly send and receive messages with any other cocalc users
  • create and manage users in an organization, including automatically generating authentication links, so you're users do not have explicitly create a CoCalc account. You can see when they are active and send them messages.

Currently a project specific API key can be used to: