Skip to content
Back to Nouncify

Quick Start

This guide walks you through creating a collection, adding a user, embedding the recorder, and retrieving a play link.

  1. Create a collection

    Terminal window
    curl -X POST https://api.nouncify.com/v1/collections \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"name": "My Team", "description": "Name pronunciations for the team"}'

    Response:

    {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Team",
    "description": "Name pronunciations for the team",
    "member_count": 0,
    "recorded_count": 0,
    "created_at": "2026-04-01T00:00:00Z"
    }
  2. Add a user and send an invitation

    Terminal window
    curl -X POST https://api.nouncify.com/v1/collections/{collection_id}/users \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
    "email": "priya.patel@company.com",
    "first_name": "Priya",
    "last_name": "Patel",
    "send_invite": true
    }'

    The user will receive an email with a link to record their name — no Nouncify account needed.

  3. Or embed the recorder directly

    Generate an embed token and use the JS SDK:

    Terminal window
    curl -X POST https://api.nouncify.com/v1/embed/token \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"collection_id": "{collection_id}", "user_id": "{user_id}"}'

    Then add to your page:

    <script src="https://embed.nouncify.com/embed.js"></script>
    <script>
    Nouncify.openRecorder({
    token: 'emb_tk_...',
    onSuccess: (result) => {
    console.log('Play link:', result.play_link);
    },
    });
    </script>
  4. Retrieve the play link

    Terminal window
    curl https://api.nouncify.com/v1/collections/{collection_id}/users/{user_id}/play-link \
    -H "Authorization: Bearer YOUR_API_KEY"

    Response:

    {
    "play_link": "https://api.nouncify.com/p/HkJ3mN8x",
    "play_url": "https://api.nouncify.com/p/HkJ3mN8x.mp3",
    "display_name": "Priya Patel",
    "status": "active"
    }
  5. Display in your app

    Embed the play link as an iframe widget or link directly to the audio:

    <!-- Inline widget (200x40px) -->
    <iframe src="https://api.nouncify.com/p/HkJ3mN8x/embed"
    width="200" height="40"
    frameborder="0"></iframe>
    <!-- Or use the audio URL directly -->
    <audio src="https://api.nouncify.com/p/HkJ3mN8x.mp3" controls></audio>