History

dumbmoron 9cc6fd13fa api/core: skip turnstile verification if user authed with api key		2024-10-04 17:37:57 +00:00
..
src	api/core: skip turnstile verification if user authed with api key	2024-10-04 17:37:57 +00:00
LICENSE	api: move agpl license into subdir	2024-09-09 21:21:13 +06:00
package.json	api/security: implement api keys as method of authentication	2024-10-04 14:58:56 +00:00
README.md	docs/api: also link to old docs for now	2024-09-09 15:50:51 +00:00

README.md

cobalt api

license

cobalt api code is licensed under AGPL-3.0.

this license allows you to modify, distribute and use the code for any purpose as long as you:

give appropriate credit to the original repo when using or modifying any parts of the code,
provide a link to the license and indicate if changes to the code were made, and
release the code under the same license

running your own instance

if you want to run your own instance for whatever purpose, follow this guide. it's highly recommended to use a docker compose method unless you run for developing/debugging purposes.

accessing the api

currently, there is no publicly accessible main api. we plan on providing a public api for cobalt 10 in some form in the future. we recommend deploying your own instance if you wish to use the latest api. you can access the documentation for it here.

if you are looking for the documentation for the old (7.x) api, you can find it here