PostEverywhere Scopes Reference

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

The three API key scopes: read, write and ai#

Scope	Endpoints	Description
read (default)	All GET endpoints	List accounts, posts, media, campaigns, webhooks, analytics, and the introspection endpoint /me.
write	All mutating endpoints	Create/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.

Choosing scopes when you create a key#

When creating an API key on the Developers page of the PostEverywhere dashboard:

1. Click Create a key
2. Select the scopes you need -- read is pre-selected; a key created through the API with no scopes gets read only
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.

What each scope permits#

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 the AI endpoints. Grants access to:

• Generate Image -- Create images from text prompts with a choice of image models
• 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 403 insufficient_scope.

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.

Related authentication pages#

• Authentication -- how to use your API key
• Generate Image -- AI image generation endpoint

Related: AI credits included in each plan