Skip to content
Binclusive Docs

How to create and use an API key

The public API is available on every plan, including Free — Free-plan keys just get lower rate limits than paid plans. This guide gets you from no key to a working request; for the full set of endpoints, see your account’s API reference and browsable docs (linked from the API Keys page).

Create a key

Section titled “Create a key”
  1. Go to Settings → API Keys.
  2. Select Create key.
  3. Choose the scopes this key needs — for example, read access to projects, or write access to descriptions, exports, or webhooks. Grant only what the key actually needs; you can create more keys with different scopes later.
  4. Confirm creation.

The full key secret is shown exactly once, at creation. Copy it and store it somewhere safe immediately — if you navigate away without saving it, you can’t retrieve it again and will need to create a new key.

If you’re creating the key inside an organization workspace, it’s scoped to the organization rather than to you personally, and keeps working even if you later leave or are removed from the organization — see Invite and manage team members.

Make your first request

Section titled “Make your first request”

Send your key as a bearer token on every request. The simplest way to confirm a key works is to call the account-info endpoint — check your account’s API reference for the exact path if this one has changed:

Terminal window
curl -X GET https://studioapi.binclusive.io/v1/me \
  -H "Authorization: Bearer YOUR_KEY_HERE"

A 200 response confirms the key is valid and shows which plan and scopes it has.

A first real call

Section titled “A first real call”

Once a key works, here’s a minimal example that does something useful — describing a single image in one call:

Terminal window
curl -X POST https://studioapi.binclusive.io/v1/images/describe \
  -H "Authorization: Bearer YOUR_KEY_HERE" \
  -F image=@photo.jpg

The response includes the generated description. For the exact response shape and field naming, see your account’s API reference.

Revoke a key

Section titled “Revoke a key”

If a key is compromised or no longer needed, go to Settings → API Keys, find it in the list, and select Revoke. Revoked keys stop working immediately and can’t be reactivated — create a new key if you need to restore access.