Partner Workflows

Create partner team

Provision a Scribeless customer team from an approved partner account.

Approved partners can provision a new Scribeless customer team, invite the customer owner, and receive an API key for that customer team.

POST https://platform.scribeless.co/api/partner/teams

This endpoint is only enabled for approved partner accounts. To become an approved partner, contact the Scribeless team.

Headers

Content-Type: application/json
X-API-Key: YOUR_PARTNER_API_KEY

Request body

Field	Type	Description
`email`	string	Email address for the customer team owner.
`firstName`	string	Customer owner's first name.
`lastName`	string	Customer owner's last name.
`companyName`	string	Company name for the new Scribeless team.
`billingRedirectUrl`	string	Optional HTTPS URL in your app where Scribeless should send the customer after invoice billing setup. Maximum length is 500 characters.

Example request

curl --request POST 'https://platform.scribeless.co/api/partner/teams' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_PARTNER_API_KEY' \
  --data '{
    "email": "ada@example.com",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "companyName": "Example Co",
    "billingRedirectUrl": "https://partner.example.com/scribeless/billing-return"
  }'

Response

Successful requests return the new customer team, owner invitation, and customer-team API key.

{
  "teamId": "TEAM_ID",
  "apiKey": {
    "id": "API_KEY_ID",
    "name": "Partner Customer API Key",
    "key": "CUSTOMER_TEAM_API_KEY",
    "created_at": "2026-01-01T10:00:00.000000+00:00"
  },
  "owner": {
    "userId": "USER_ID",
    "email": "ada@example.com"
  },
  "invitation": {
    "id": "INVITATION_ID",
    "status": "pending"
  },
  "billingSetupUrl": "https://platform.scribeless.co/partner-checkout?sessionId=CHECKOUT_SESSION_SECRET",
  "links": {
    "templatesUrl": "https://platform.scribeless.co/templates"
  }
}

Store apiKey.key securely when it is returned. For security, API key secrets may not be retrievable later.

Use the returned customer-team API key for customer-scoped endpoints such as GET /api/account/status, GET /api/templates, POST /api/campaigns, and POST /api/recipients.

Use billingSetupUrl when the customer needs to add a payment method during onboarding. If you send billingRedirectUrl, the returned setup URL uses partner checkout and redirects the customer back to your app after setup. For one-time campaign recipient checkout that should return customers to your app after payment, send redirectUrl to POST /api/recipients/checkout with the returned customer-team API key.

Errors

Status	Meaning
`400`	Missing or invalid customer details, or invalid `billingRedirectUrl`.
`401`	Missing, malformed, invalid, unauthorized, or non-partner API key.
`500`	Team provisioning failed. Retry or contact support if it persists.

PNG API

Render Scribeless handwriting text as a PNG.

Account status

Check whether a Scribeless account is ready for API-driven sending.