Skip to content

docs(partner-integration): add self-serve partner key provisioning section #941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
erikengervall wants to merge 3 commits into
base: main
Choose a base branch
from
+57 −0
Draft

docs(partner-integration): add self-serve partner key provisioning section #941

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff36f75
docs(partner-integration): add self-serve partner key provisioning se…
erikengervall May 5, 2026
0e6a871
Merge remote-tracking branch 'origin/main' into noaa/mar-900-create-s…
erikengervall May 12, 2026
eead1cc
Merge remote-tracking branch 'origin/main' into noaa/mar-900-create-s…
erikengervall May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions partner-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,63 @@ Authorization: Bearer <partner key>

Partner keys are distinct from standard Firecrawl API keys and are provided directly by the Firecrawl team.

## Self-serve partner keys

You can self-provision a partner key (integration key) using the Firecrawl Integrations service.

**Base URL**

```
https://integrations.firecrawl.dev
```

**Endpoint**

```
POST /partner/v1/integrations/self-serve
```

**Request**

```bash
curl -X POST "https://integrations.firecrawl.dev/partner/v1/integrations/self-serve" \
-H "Content-Type: application/json" \
-d '{"display_name":"Acme","domain":"acme.com","metadata":{}}'
```

**Body**

| Field | Type | Required | Description |
|------|------|----------|-------------|
| `display_name` | string | Yes | Display name for the integration |
| `domain` | string | No | Optional partner domain |
| `metadata` | object | No | Optional JSON object for additional data |

**Response (`200 OK`)**

```json
{
"apiKey": "…",
"slug": "acme-1a2b3c",
"displayName": "Acme"
}
```

| Field | Type | Description |
|------|------|-------------|
| `apiKey` | string | Your partner key (integration key). **Shown once** — store it securely. |
| `slug` | string | Stable integration identifier used for scoping partner-created teams/keys |
| `displayName` | string | Echo of the integration display name |

**Errors**

| Status | Description |
|--------|-------------|
| `400` | Invalid request body |
| `409` | Failed to allocate unique slug |
| `429` | Rate limit exceeded |
| `500` | Internal server error |

## Security Requirements

- **Server-side only**: Partner keys must only be used in server-side code. Never expose a partner key in frontend code, client-side JavaScript, or mobile applications.
Expand Down