Mirrors/cobalt
1
0
Fork 0
mirror of https://github.com/wukko/cobalt.git synced 2025-06-12 13:17:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs/api: update warnings

Browse Source
This commit is contained in:
wukko
2024-10-20 16:51:38 +06:00
parent c3f3499a42
commit 7515204bb7
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api.md
View File

@ -1,8 +1,8 @@
# cobalt api documentation
this document provides info about methods and acceptable variables for all cobalt api requests.
> if you are looking for the documentation for the old (7.x) api, you can find
> it [here](https://github.com/imputnet/cobalt/blob/7/docs/api.md)
> [!IMPORTANT]
> hosted api instances (such as api.cobalt.tools) use bot protection and are not intended to be used in other projects without explicit permission. if you want to access the cobalt api reliably, you should [host your own instance](/docs/run-an-instance.md).
## authentication
an api instance may be configured to require you to authenticate yourself.
@ -46,9 +46,10 @@ cobalt's main processing endpoint.
request body type: `application/json`
response body type: `application/json`
```
⚠️ you must include Accept and Content-Type headers with every `POST /` request.
> [!IMPORTANT]
> you must include `Accept` and `Content-Type` headers with every `POST /` request.
```
Accept: application/json
Content-Type: application/json
```