From ff36f75042e64cde34f283ffde047d536ec2cd7d Mon Sep 17 00:00:00 2001 From: Erik Engervall Date: Tue, 5 May 2026 16:53:06 +0200 Subject: [PATCH] docs(partner-integration): add self-serve partner key provisioning section --- partner-integration.mdx | 57 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/partner-integration.mdx b/partner-integration.mdx index 1bcb6fc6..d8a5e1d2 100644 --- a/partner-integration.mdx +++ b/partner-integration.mdx @@ -31,6 +31,63 @@ Authorization: Bearer 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.