octoque
API and AI assistants

Create an API key

API keys let your scripts or an AI assistant work with your Octoque workspace. Each key has only the permissions you give it.

Updated

Before you start

  • You’re the workspace owner or an admin.
  • A paid plan or the trial (Free has no API access).

Steps

  1. Go to You → Developers & AI.
  2. Tap New API key.
  3. Give it a Name you’ll recognise, such as the tool that will use it.
  4. Under What it can do, tick only what it needs: Read posts and results, Create drafts, Schedule and publish, Connect accounts.
  5. Tap Create key, then Copy. “This is the only time it’s shown.” Store it somewhere safe.

What you’ll see

The key is listed with its first characters, permissions and when it was last used. Tap Revoke to stop it at once. For endpoints and examples, see Developers and the API reference.

Keys can’t reach account-level actions such as billing, the team, passwords, data export or deleting the account. Those need you signed in.

Troubleshooting

  • API access is on every paid plan. Upgrade to create a key.

    Choose a plan under Plan & billing.

  • That API key is wrong or was revoked.

    Check you copied the whole key. If it was revoked, create a new one.

  • This API key doesn't have the post.publish scope.

    The key lacks that permission. Create a new key with it ticked.

  • You can't give a key permissions you don't have: account.manage.

    Your role doesn’t have that permission, so your keys can’t either.

  • This needs you signed in to Octoque; API keys can't do it.

    Do it in the app instead.

Related articles

Last updated . Found something out of date? Tell us at hello@octoque.com. More in API and AI assistants