API
This is a custom API, written in Python using FastAPI, to help me accomplish tasks the can be improved through a RESTful API
Setup
Simplest setup is to start from compose.yml and template.env, which should be renamed to .env
Environment Vairables
API_KEY- Any long, random string. Keep this secret as this is the only form of authentication for the API. All routes require it, except/health-check/DATABASE_URL- The URL to connect to postgres DB. Must start withpostgresql+psycopg://. Should be in the format specifiec in template.envTZ- Timezone of the containerPGTZ- Timezone the Postgres container should useNEXTCLOUD_URL- Base URL (must behttps://) of the Nextcloud instance used by/webhook/nextcloud-talkNEXTCLOUD_TALK_TOKEN- Conversation token of the registered Nextcloud Talk bot used by/webhook/nextcloud-talkNEXTCLOUD_TALK_SECRET- Shared secret of the registered Nextcloud Talk bot used by/webhook/nextcloud-talk
Webhooks
POST /webhook/nextcloud-talk- Forwards aheaderandmessageto a Nextcloud Talk conversation via the Nextcloud Talk Bot API, using the nctalk package. Requires theX-API-KEYheader and a JSON body:{"header": "...", "message": "..."}
How to Access
Using the compose.yml file, you can access the API at http://<IP>:5000/health-check. If everything is setup correctly, you should see {"status":"ok"}
1 maintainer
Metadata
1 maintainer
Release files for js-api 0.3.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| js_api-0.3.3.tar.gz | 26.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| js_api-0.3.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 53.4 kB
Release files / js_api-0.3.3.tar.gz
| Download URL | js_api-0.3.3.tar.gz |
|---|---|
| Size | 26.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
21cb06573e481bca2c4c25f08b58e55b5f9f354181d667007d28399de9a0d3da
|
|
BLAKE2b-256 checksum How to use checksums |
4f236d125e8775057f572e5f075ee43f1f8cc988bab1e13cf2177bd462043347
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.
Transparency logRelease files / js_api-0.3.3-py3-none-any.whl
| Download URL | js_api-0.3.3-py3-none-any.whl |
|---|---|
| Size | 26.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa2495166fcb1485e30be5400e5cc6ac1067ca4230178734231cd6283cfdf09b
|
|
BLAKE2b-256 checksum How to use checksums |
49431c5f45c5aa72bf66e1ebeb5d9ba2636fcd4ef9a34400de20088b94d08e18
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.
Transparency log
