> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate ERN for a Product

> Starts an ERN generation flow for a single product and provider.

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/ddex/ern/generate', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "productId": "sample-productId",
      "providerId": "sample-providerId",
      "options": {
        "messageControlType": "sample-messageControlType",
        "includeDeals": true,
        "includeMEADHooks": true,
        "autoDeliver": true,
        "priority": "sample-priority",
        "customSettings": {}
      }
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
    'https://api.royalti.io/ddex/ern/generate',
    json={"productId":"sample-productId","providerId":"sample-providerId","options":{"messageControlType":"sample-messageControlType","includeDeals":true,"includeMEADHooks":true,"autoDeliver":true,"priority":"sample-priority","customSettings":{}}}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/ddex/ern/generate \
    -H "Content-Type: application/json" \
    -d '{"productId":"sample-productId","providerId":"sample-providerId","options":{"messageControlType":"sample-messageControlType","includeDeals":true,"includeMEADHooks":true,"autoDeliver":true,"priority":"sample-priority","customSettings":{}}}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /ddex/ern/generate
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /ddex/ern/generate:
    post:
      tags:
        - DDEX
      summary: Generate ERN for a Product
      description: Starts an ERN generation flow for a single product and provider.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - productId
                - providerId
              properties:
                productId:
                  type: string
                  format: uuid
                providerId:
                  type: string
                  format: uuid
                options:
                  type: object
                  properties:
                    messageControlType:
                      type: string
                      default: LiveMessage
                    includeDeals:
                      type: boolean
                      default: true
                    includeMEADHooks:
                      type: boolean
                      default: true
                    autoDeliver:
                      type: boolean
                      default: false
                    priority:
                      type: string
                      enum:
                        - low
                        - normal
                        - high
                      default: normal
                    customSettings:
                      type: object
      responses:
        '202':
          description: Accepted - ERN generation flow started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DDEXWorkflowAccepted'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    DDEXWorkflowAccepted:
      type: object
      properties:
        workflowId:
          type: string
        status:
          type: string
        estimatedCompletion:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: error
              message:
                type: string
                example: Invalid request parameters
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: error
              message:
                type: string
                example: Unauthorized
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: error
              message:
                type: string
                example: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````