feat: fix docs

Author: nevo-david

pages/public-api.mdx

@@ -3,13 +3,15 @@ title: Public API
 description: "How to use Postiz public API"
 ---
 
-import {Callout} from 'nextra/components';
+import { Callout } from "nextra/components";
 
 <Callout type="warning">
-	**Warning:** This Feature is currently in Beta and is in active-development. It does **not** provide all of the Postiz Features currently.
+  **Warning:** This Feature is currently in Beta and is in active-development.
+  It does **not** provide all of the Postiz Features currently.
 </Callout>
 
 ## For NodeJS users
+
 You can use the <a href="https://www.npmjs.com/package/@postiz/node" target="_blank">Postiz NodeJS SDK</a> to interact with the Postiz Public API.<br />
 
 For a custom n8n node check <a href="https://www.npmjs.com/package/n8n-nodes-postiz" target="_blank">Postiz n8n custom node</a><br />
@@ -22,12 +24,22 @@ If you are using the hosted version of Postiz the URL will be `https://api.posti
 If you are self-hosting Postiz the URL will be `https://{NEXT_PUBLIC_BACKEND_URL}/public/v1`.<br /><br />
 
 <u>There is a limit of **30** requests per hour.</u>
+It does not mean you can post only 30 posts per hour, it means you can make 30
+requests to the API per hour. If you plan ahead, you can have a lot more every
+hour.
+
 <br />
-Here are the following API endpoints you can use:
+
+<strong>
+  NOTE: The UI representation is a `channel`, but on the API it is called
+  `integration`. So when you see `integration` in the API, it means a `channel`.
+</strong>
 
 <br />
 
-> NOTE: The UI representation is a `channel`, but on the API it is called `integration`. So when you see `integration` in the API, it means a `channel`.
+Here are the following API endpoints you can use:
+
+<br />
 
 ### Get all added channels
 
@@ -90,6 +102,7 @@ GET https://api.postiz.com/public/v1/posts
 ```
 
 Payload
+
 ```json
 {
   "startDate": "UTC date in ISO format - ex. 2024-12-14T08:18:54.274Z",
@@ -102,21 +115,21 @@ Response:
 
 ```json
 {
-    "posts": [
-        {
-            "id": "cm4gklk8o00008copo77fa0f8",
-            "content": "blabla",
-            "publishDate": "2024-12-09T05:06:00.000Z",
-            "releaseURL": "https://twitter.com/nevodavid/status/1865986385708204316",
-            "state": "QUEUE|PUBLISHED|ERROR|DRAFT",
-            "integration": {
-                "id": "cm4ean69r0003w8w1cdomox9n",
-                "providerIdentifier": "x",
-                "name": "Nevo David",
-                "picture": "https://uploads.gitroom.com/5g9mEIVCAq.jpeg"
-            }
-        }
-    ]
+  "posts": [
+    {
+      "id": "cm4gklk8o00008copo77fa0f8",
+      "content": "blabla",
+      "publishDate": "2024-12-09T05:06:00.000Z",
+      "releaseURL": "https://twitter.com/nevodavid/status/1865986385708204316",
+      "state": "QUEUE|PUBLISHED|ERROR|DRAFT",
+      "integration": {
+        "id": "cm4ean69r0003w8w1cdomox9n",
+        "providerIdentifier": "x",
+        "name": "Nevo David",
+        "picture": "https://uploads.gitroom.com/5g9mEIVCAq.jpeg"
+      }
+    }
+  ]
 }
 ```
 
@@ -164,47 +177,55 @@ Payload:
 Response:
 
 ```json
-[{"postId":"POST_ID","integration":"INTEGRATION_ID"}]
+[{ "postId": "POST_ID", "integration": "INTEGRATION_ID" }]
 ```
 
-<iframe style={{width: "100%", height: "680px", zoom: 0.8}} src="https://platform.postiz.com/modal/dark/all"></iframe>
+<iframe
+  style={{ width: "100%", height: "680px", zoom: 0.8 }}
+  src="https://platform.postiz.com/modal/dark/all"
+></iframe>
 
 ### Request
-| Property | Type | Required | Description |
-| --- | --- | --- | --- |
-| type | `draft` \| `schedule` \| `now` | Yes | Type of post creation |
-| order | string | No | Order of posts |
-| shortLink | boolean | Yes | Whether to use short link |
-| inter | number | No | Interval |
-| date | string (Date) | Yes | Date of post |
-| tags | Tags[] | Yes | Array of tags |
-| posts | Post[] | Yes (if type !== 'draft') | Array of posts |
+
+| Property  | Type                           | Required                  | Description               |
+| --------- | ------------------------------ | ------------------------- | ------------------------- |
+| type      | `draft` \| `schedule` \| `now` | Yes                       | Type of post creation     |
+| order     | string                         | No                        | Order of posts            |
+| shortLink | boolean                        | Yes                       | Whether to use short link |
+| inter     | number                         | No                        | Interval                  |
+| date      | string (Date)                  | Yes                       | Date of post              |
+| tags      | Tags[]                         | Yes                       | Array of tags             |
+| posts     | Post[]                         | Yes (if type !== 'draft') | Array of posts            |
 
 ### Posts
-| Property | Type | Required | Description |
-| --- | --- | --- | --- |
-| integration | Integration | Yes | Integration details |
-| value | PostContent[] | Yes | Array of post content |
-| group | string | No | Group name |
-| settings | AllProvidersSettings | No | Settings for providers |
+
+| Property    | Type                 | Required | Description            |
+| ----------- | -------------------- | -------- | ---------------------- |
+| integration | Integration          | Yes      | Integration details    |
+| value       | PostContent[]        | Yes      | Array of post content  |
+| group       | string               | No       | Group name             |
+| settings    | AllProvidersSettings | No       | Settings for providers |
 
 ### Post Value
-| Property | Type | Required | Description |
-| --- | --- | --- | --- |
-| content | string | Yes | Post content |
-| id | string | No | Post ID |
-| image | MediaDto[] | No | Array of media |
+
+| Property | Type       | Required | Description    |
+| -------- | ---------- | -------- | -------------- |
+| content  | string     | Yes      | Post content   |
+| id       | string     | No       | Post ID        |
+| image    | MediaDto[] | No       | Array of media |
 
 ### Integration
-| Property | Type | Required | Description |
-| --- | --- | --- | --- |
-| id | string | Yes | Integration ID |
+
+| Property | Type   | Required | Description    |
+| -------- | ------ | -------- | -------------- |
+| id       | string | Yes      | Integration ID |
 
 ### Tags
-| Property | Type | Required | Description |
-| --- | --- | --- | --- |
-| value | string | Yes | Tag value |
-| label | string | Yes | Tag label |
+
+| Property | Type   | Required | Description |
+| -------- | ------ | -------- | ----------- |
+| value    | string | Yes      | Tag value   |
+| label    | string | Yes      | Tag label   |
 
 ---
 
@@ -228,19 +249,24 @@ Response:
 ## NEW! (Generate videos with AI)
 
 Request:
+
 ```http
 POST https://api.postiz.com/public/v1/generate-video
 ```
 
 Response:
+
 ```json
-[{
-  "id": "string",
-  "path": "URL of the generated video"
-}]
+[
+  {
+    "id": "string",
+    "path": "URL of the generated video"
+  }
+]
 ```
 
 ### Payload (Slides of images)
+
 ```json
 {
   "type": "image-text-slides",
@@ -253,11 +279,13 @@ Response:
 ```
 
 Get voices
+
 ```http
 POST https://api.postiz.com/public/v1/video/function
 ```
 
 Payload
+
 ```json
 {
   "functionName": "loadVoices",
@@ -266,6 +294,7 @@ Payload
 ```
 
 Response
+
 ```json
 {
   "voices": [
@@ -278,14 +307,15 @@ Response
 ```
 
 ### Payload (VEO3 fast video) - Subscribed users after trial
+
 ```json
 {
   "type": "veo3",
   "output": "vertical|horizontal",
   "customParams": {
     "prompt": "",
     // images - optional (Maximum 3 images)
-    "images": [{"id": "string", "path": "string"}]
+    "images": [{ "id": "string", "path": "string" }]
   }
 }
-```
+```