API reference

Base URL

https://<your-project>.cloudfunctions.net

All endpoints are prefixed with /api.

Health check

Returns service health status. No authentication required.

{
  "status": "healthy",
  "timestamp": "2026-03-14T12:00:00.000Z"
}

Authentication

Validate Neural DSP cloud credentials. Free

{
  "credentials": {
    "email": "user@example.com",
    "password": "..."
  }
}

{ "success": true, "message": "Login successful" }

Account

All account endpoints require a Firebase ID token in the Authorization header.

Returns your current credit balance.

{ "credits": 250 }

Create a new API key.

{ "name": "My Store Key" }

{
  "apiKeyId": "key_abc123",
  "apiKey": "ndsp_live_xxxxxxxxxxxxxxxx",
  "keyPreview": "ndsp_...x4f2"
}

List all your API keys.

{
  "items": [
    {
      "id": "key_abc123",
      "name": "My Store Key",
      "keyPreview": "ndsp_...x4f2",
      "createdAt": "Mar 14, 2026",
      "isActive": true
    }
  ]
}

Get usage statistics for a specific API key.

{
  "totalRequests": 142,
  "creditsUsed": 87,
  "lastActivity": "2026-03-14T10:30:00Z",
  "operationBreakdown": {
    "presetShare": 8,
    "follow": 3,
    "login": 12
  }
}

NDSP Credentials

Manage your stored Neural DSP cloud credentials. All endpoints require Firebase authentication.

Check if credentials are stored and their validation status.

Save or update your NDSP credentials. Free

{
  "email": "ndsp-user@example.com",
  "password": "your-ndsp-password"
}

Validate your currently stored credentials against Cortex Cloud. Free

Permanently delete your stored credentials.

Store Integrations

Manage webhook integrations for your stores. All endpoints require Firebase authentication.

List all your store integrations.

Create a new store integration.

{
  "name": "My Shopify Store",
  "provider": "shopify",
  "apiKeyId": "key_abc123",
  "itemMappings": [
    {
      "matchType": "sku",
      "externalRef": "STORM-LEAD-V2",
      "resourceType": "preset",
      "resourceId": "abc123-preset-id"
    }
  ]
}

Update an existing store integration (name, mappings, etc.).

Rotate the webhook signing secret for an integration.

List delivery attempts for an integration.

Update a delivery's target NDSP username (for failed deliveries with incorrect usernames).

{ "targetUsername": "correct_username" }

Retry a failed or waiting delivery.

Webhooks

Receive order webhooks from store platforms. Authenticated via HMAC signature verification. See the Webhooks guide for payload formats.

Credit packs

List packs, check account credits, and create one-time Stripe Checkout sessions.

List available credit packs and current operation costs. Public, no authentication required.

Get the authenticated account credit balance. Requires Firebase authentication.

Create a Stripe Checkout session for a credit pack. Requires Firebase authentication.

{
  "packId": "growth",
  "currency": "usd",
  "successUrl": "https://yoursite.com/success",
  "cancelUrl": "https://yoursite.com/cancel"
}

{
  "sessionId": "cs_live_xxxxx",
  "url": "https://checkout.stripe.com/c/pay/..."
}

Billing

Credit balance and pricing endpoints for API key clients.

Get your current credit balance and rate limit info.

Get credit costs for all operations. Public, no authentication required.

Error responses

All errors follow a consistent format:

{
  "error": {
    "message": "Human-readable error description",
    "code": "MACHINE_READABLE_CODE"
  }
}