Базовый адрес
Отправляйте все запросы на этот адрес. Self-hosted PostNimbo использует адрес собственного бэкенда.
https://postnimbo.com/api/public/v1
Аутентификация
Передавайте учётные данные в заголовке Authorization как есть, без префикса Bearer. Подходят два варианта:
- API-ключ из раздела Settings > Agents / Dev. Он действует от имени всего рабочего пространства и даёт доступ ко всем маршрутам ниже.
- Токен доступа OAuth (начинается с pos_), полученный через OAuth-приложение. Он действует от имени участника, который его одобрил, видит только его бренды и каналы и ограничен одобренными им областями доступа.
curl https://postnimbo.com/api/public/v1/me \ -H "Authorization: <api key or pos_ token>"
При отсутствии или ошибке в учётных данных возвращается 401. Если маршрут не одобрен для токена, возвращается 403. В ошибках есть поле msg или message.
Ограничения частоты запросов
- 120 запросов в минуту для каждого API-ключа или токена по всем маршрутам вместе.
- Создание постов также ограничено для каждого рабочего пространства в час (по умолчанию 90).
- При превышении лимита возвращается 429 с заголовком Retry-After в секундах. Подождите указанное время, прежде чем повторить запрос.
Self-hosted серверы задают собственные лимиты через PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL и API_LIMIT.
Эндпоинты
В столбце «Область доступа» указано, что нужно токену OAuth. API-ключ даёт доступ ко всем маршрутам.
Account
- GET
/public/v1/meThe workspace the credential belongs to, and for an OAuth token the member who approved it.
Область доступаЛюбой токен - GET
/public/v1/is-connectedCheck that the credential works.
Область доступаЛюбой токен - GET
/public/v1/groupsThe brands (customers) the credential can see.
Область доступаЛюбой токен - GET
/public/v1/countsPosts waiting for approval and unread open inbox conversations.
Область доступаposts:readinbox:readВходные данныеquery: brandId?
Channels
- GET
/public/v1/integrationsThe connected channels, with their ids and networks.
Область доступаposts:readВходные данныеquery: group? (a brand id) - GET
/public/v1/integration-settings/:idThe rules of a channel: character limits, media rules and the settings a post needs.
Область доступаAPI-ключ или токен с полным доступом - GET
/public/v1/find-slot/:idThe next free posting slot of a channel.
Область доступаposts:read - GET
/public/v1/social/:integrationThe sign-in link that connects a new channel of a network (for example linkedin).
Область доступаAPI-ключ или токен с полным доступомВходные данныеquery: refresh? (a channel id to reconnect) - DELETE
/public/v1/integrations/:idDisconnect a channel.
Область доступаAPI-ключ или токен с полным доступом - POST
/public/v1/integration-trigger/:idRun a lookup a network offers (for example the playlists of a YouTube channel).
Область доступаAPI-ключ или токен с полным доступомВходные данныеbody: { methodName, data }
Posts
- GET
/public/v1/postsThe posts between two dates.
Область доступаposts:readВходные данныеquery: startDate, endDate (ISO 8601), customer? - POST
/public/v1/postsCreate a draft, schedule a post or publish now, on one or more channels.
Область доступаposts:scheduleВходные данныеbody: { type: draft|schedule|now, date, shortLink, tags, posts: [{ integration: { id }, value: [{ content, image? }], settings? }] } - PUT
/public/v1/posts/:id/settingsChange the network settings of a post.
Область доступаAPI-ключ или токен с полным доступомВходные данныеbody: { settings } - PUT
/public/v1/posts/:id/statusMove a post between draft and scheduled.
Область доступаAPI-ключ или токен с полным доступомВходные данныеbody: { status: draft|schedule } - GET
/public/v1/posts/:id/missingFor a post the network accepted without returning its id: the recent posts of the channel to pick it from.
Область доступаAPI-ключ или токен с полным доступом - PUT
/public/v1/posts/:id/release-idLink a post to the network post it became.
Область доступаAPI-ключ или токен с полным доступомВходные данныеbody: { releaseId } - DELETE
/public/v1/posts/:idDelete a post.
Область доступаAPI-ключ или токен с полным доступом - DELETE
/public/v1/posts/group/:groupDelete every post of a group (one post sent to several channels).
Область доступаAPI-ключ или токен с полным доступом
Media
- POST
/public/v1/uploadUpload a file to the media library.
Область доступаmedia:writeВходные данныеmultipart: file, adjust? - POST
/public/v1/upload-from-urlAdd a file from a public https address.
Область доступаmedia:writeВходные данныеbody: { url, adjust? } - GET
/public/v1/mediaThe media library, a page at a time.
Область доступаAPI-ключ или токен с полным доступомВходные данныеquery: page?, search?, folder? - GET
/public/v1/media/:id/statusWhether an uploaded video finished processing.
Область доступаAPI-ключ или токен с полным доступом
Ideas
- POST
/public/v1/ideasSave an idea to the Ideas board.
Область доступаideas:writeВходные данныеbody: { title, content? } - DELETE
/public/v1/ideas/:idRemove an idea the credential saved.
Область доступаideas:write
Analytics
- GET
/public/v1/performanceA summary of the last 7 days: posts, reach and engagement.
Область доступаanalytics:readВходные данныеquery: brandId?, tz? - GET
/public/v1/best-times/nextThe next best times to post, from your own results.
Область доступаposts:readВходные данныеquery: integrationId?, brandId?, tz?, goal?: engagement|reach|views, count? (1-20) - GET
/public/v1/analytics/:integrationThe analytics of a channel.
Область доступаAPI-ключ или токен с полным доступомВходные данныеquery: date (days back) - GET
/public/v1/analytics/post/:postIdThe analytics of one published post.
Область доступаAPI-ключ или токен с полным доступомВходные данныеquery: date (days back)
AI
- POST
/public/v1/ai/draftDraft a post about a web page with PostNimbo AI.
Область доступаai:useВходные данныеbody: { url, title?, selection?, mode: summary|captions } - POST
/public/v1/ai/replyDraft a reply to a comment or message.
Область доступаai:useВходные данныеbody: { text, url? }
Link in bio
- GET
/public/v1/link-in-bioThe link-in-bio pages of the workspace.
Область доступаlink-in-bio:write - POST
/public/v1/link-in-bio/:id/linksAdd a link to a link-in-bio page.
Область доступаlink-in-bio:writeВходные данныеbody: { label, url }
Video and clipping
- POST
/public/v1/generate-videoGenerate a video with one of the AI video tools.
Область доступаAPI-ключ или токен с полным доступом - POST
/public/v1/video/functionLoad the options of a video tool (voices, avatars).
Область доступаAPI-ключ или токен с полным доступом - POST
/public/v1/clippingCut a long video into short clips.
Область доступаAPI-ключ или токен с полным доступом - GET
/public/v1/clippingThe clipping jobs, a page at a time.
Область доступаAPI-ключ или токен с полным доступомВходные данныеquery: page - GET
/public/v1/clipping/:idOne clipping job and its clips.
Область доступаAPI-ключ или токен с полным доступом
Notifications
- GET
/public/v1/notificationsThe workspace notifications, a page at a time.
Область доступаAPI-ключ или токен с полным доступомВходные данныеquery: page?
Webhooks
- GET
/public/v1/webhooks/eventsThe events a webhook is sent, with a sample payload of each.
Область доступаЛюбой токен - GET
/public/v1/webhooksThe webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.
Область доступаwebhooks:writeВходные данныеquery: url? - POST
/public/v1/webhooksSubscribe an address to events (how Zapier, Make and n8n triggers switch on).
Область доступаwebhooks:writeВходные данныеbody: { url, events?, integrations? (channel ids), name? } - DELETE
/public/v1/webhooks/:idRemove a webhook (how a trigger switches off).
Область доступаwebhooks:write
