Skip to content

API Endpoint for self hosted Postiz #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

API Endpoint for self hosted Postiz #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/public-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For a custom n8n node check <a href="https://www.npmjs.com/package/n8n-nodes-pos
To use the Public API, go to Postiz settings and copy the API Key.<br />
With each request you need to pass the API Key in the header `Authorization: {apiKey}`.<br />
If you are using the hosted version of Postiz the URL will be `https://api.postiz.com/public/v1`.<br />
If you are self-hosting Postiz the URL will be `https://{NEXT_PUBLIC_BACKEND_URL}/public/v1`.<br />
If you are self-hosting Postiz the URL will be `https://{NEXT_PUBLIC_BACKEND_URL}/api/`.<br />
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Clarify self-hosted base URL (trailing slash + scheme duplication).

  • Drop the trailing slash to avoid double slashes when composing paths.
  • Confirm whether NEXT_PUBLIC_BACKEND_URL already includes the scheme. If yes, remove the hardcoded https:// prefix here to prevent https://https://... issues.

Apply this minimal edit:

-If you are self-hosting Postiz the URL will be `https://{NEXT_PUBLIC_BACKEND_URL}/api/`.<br />
+If you are self-hosting Postiz the base URL will be `https://{NEXT_PUBLIC_BACKEND_URL}/api`.<br />
+<br />
+Tip: If `NEXT_PUBLIC_BACKEND_URL` already includes the scheme (e.g., `https://postiz.example.com`), prefer `{NEXT_PUBLIC_BACKEND_URL}/api` without adding another `https://`.

🏁 Script executed:

#!/bin/bash
set -e
echo "🔍 Searching for NEXT_PUBLIC_BACKEND_URL occurrences:"
rg -n "NEXT_PUBLIC_BACKEND_URL" || true

echo
echo "📄 Listing environment example files:"
fd --hidden --max-depth 2 --type f .env* || true

Length of output: 919

🏁 Script executed:

#!/bin/bash
set -e
rg -n -C3 "NEXT_PUBLIC_BACKEND_URL" pages/configuration/reference.mdx

Length of output: 207

Clarify self-hosted base URL usage (avoid duplicate schemes and trailing slash)

Drop the trailing slash and guide users on when to include the https:// prefix:

-file: pages/public-api.mdx:24
-If you are self-hosting Postiz the URL will be `https://{NEXT_PUBLIC_BACKEND_URL}/api/`.<br />
+If you are self-hosting Postiz the base URL is `https://{NEXT_PUBLIC_BACKEND_URL}/api`.<br />
+
+Tip: if `NEXT_PUBLIC_BACKEND_URL` already includes `https://` (for example, `https://postiz.example.com`), use `{NEXT_PUBLIC_BACKEND_URL}/api` without an extra `https://`.
🤖 Prompt for AI Agents 
In pages/public-api.mdx around line 24, update the example URL text to remove
the trailing slash and add guidance about the scheme: change the example to use
https://{NEXT_PUBLIC_BACKEND_URL}/api (no trailing slash) and add a short note
that users should include the scheme (https://) only if NEXT_PUBLIC_BACKEND_URL
does not already contain it to avoid duplicate schemes.


<u>There is a limit of **30** requests per hour.</u><br />
It does not mean you can post only 30 posts per hour, it means you can make 30 <br />
Expand Down