Skip to main content

API Key Scopes

Scopes control which parts of the API your key can access. When you generate an API key, you choose which scopes to enable.

Three scopes​

ScopeEndpointsDescription
read (always included)All GET endpointsList accounts, posts, media, campaigns, webhooks, analytics, and the introspection endpoint /me.
write (always included)All mutating endpointsCreate/update/delete posts, media, campaigns, webhooks. Bulk operations and retry.
ai (opt-in)/v1/ai/*Generate images AND captions with AI. Counts against AI credit quota.

Requesting Scopes​

When generating an API key from Settings > Developers in the PostEverywhere dashboard:

  1. Click Generate API Key
  2. Select the scopes you need -- default access is always included
  3. Enable the ai scope if you plan to use the Generate Image endpoint
  4. Click Create and copy your key

You can generate multiple API keys with different scopes. For example, create one key with default access for your scheduling service and a separate key with the ai scope for your content generation pipeline.

Scope Details​

read Scope (always included)​

Grants access to all GET endpoints:

  • Accounts -- List and view connected social media accounts, check account health
  • Posts -- List and view scheduled and published posts (including advanced filters)
  • Media -- View media library
  • Campaigns -- List campaigns
  • Webhooks -- List webhook subscriptions
  • Analytics -- Aggregate metrics
  • Introspection -- /v1/me — current API key context, quota, plan

write Scope (always included)​

Grants mutating access:

  • Posts -- Create, update, delete, retry, bulk create, bulk retry
  • Media -- Upload, complete, delete
  • Campaigns -- Create, update, delete
  • Webhooks -- Create, update, delete, test

ai Scope (opt-in)​

Required for AI-powered endpoints. Grants access to:

  • Generate Image -- Create images from text prompts using models like nano-banana-pro, ideogram-v2, gemini-3-pro, and flux-schnell
  • Generate Caption -- Create AI captions tuned to the target platform's character limits + style

Both AI endpoints count against your monthly AI credit allowance. Requests without the ai scope return a 401 Unauthorized error.

AI Credits

AI image generation consumes credits from your plan's monthly allowance. Different models cost different amounts of credits. See Generate Image for the full model and pricing table.

Further Reading​