BacklinkGPTCreate API keys, use the interactive reference, and plug agents into your workspace.
The BacklinkGPT API gives your own tools the same access to a workspace that the app has: the inbox of drafted outreach and replies, the backlinks the agent has won, and the controls that steer the outreach engine. Use it for reporting, for approving drafts from a system you already run, or to record outcomes the agent cannot see.
This page is the overview. The interactive API reference is the source of truth for endpoints, request fields, response schemas, and examples.
Explore every endpoint with request and response schemas in the interactive OpenAPI docs.
Create a workspace-scoped key, set an expiry, and pause or delete it when an integration retires.
Copy-paste setup for ChatGPT, Claude, Cursor, Codex, and other MCP clients, plus starter prompts.
Workspace owners and admins create keys under API → API Keys. Give each key a name that says what uses it, such as Weekly report or Approval bot, and set an expiry if the integration is temporary.
The full key is shown once, right after creation. Store it in your secrets manager before you leave the page. If you lose it, create a new key and delete the old one.
A key is bound to the workspace it was created in and acts as the member who created it: it can do what that person can do in the app, and it stops working if they leave the workspace. Keys can only be created or resumed while the workspace has an active plan or trial.
Pause and resume any key from the row menu on the API Keys page. Requests with a paused key are rejected with 401 Unauthorized until an owner or admin resumes it. Deleting a key is immediate and cannot be undone.
Send the key in the x-api-key header. Every endpoint is relative to https://backlinkgpt.com/api/v1.
curl https://backlinkgpt.com/api/v1/inbox/mailbox-counts \
-H "x-api-key: <your-api-key>"
Each key has its own rate limit. When it is exceeded the API answers 429 Too Many Requests with a Retry-After header; back off and retry after the delay.
Open the interactive API reference to browse resources and try requests with your key. The machine-readable OpenAPI spec is there when you generate a client, wire up a tool, or review schemas outside the browser.
Keep internal docs and automations pointed at the reference rather than copying endpoint details into other documents; the reference is generated from the same code that serves the API.
Prospecting, drafting, and sending stay with the agent: the API is for reading its work and settling the decisions it leaves to you. If you need a verb that is not in the reference, the MCP server exposes the full set of Copilot tools.
Assistants such as ChatGPT, Claude, Claude Code, Codex, and Cursor talk to your workspace over MCP. The Agents page in the app has a setup prompt per client, one-click installs, and starter prompts.
OAuth is the default there and needs no key. Use an API key for agents that run unattended or need to switch between several workspaces: the same key works for MCP and for the REST API. Start with read-only prompts until you have reviewed what the agent does with write access.