​
Quickstart Guide

This guide will walk you through creating your first JSON API endpoint with Pulpminer. In just a few minutes, you’ll be able to transform any webpage into a structured JSON API.

​
Prerequisites

Before you begin, make sure you have:

  • A Pulpminer account (sign up at pulpminer.com)
  • The URL of a webpage you want to convert to an API
  • Some credits in your account (new accounts start with free credits)

​
Step 1: Access the Dashboard

  1. Sign in to your Pulpminer account
  2. Navigate to the API Generation page
  3. You’ll see the main interface with a URL input field

​
Step 2: Generate JSON from a Webpage

  1. Enter your target webpage URL in the input field
  2. Click “Generate JSON from webpage content”
  3. Wait a few seconds while our AI analyzes the page
  4. Review the generated JSON structure in the editor

The AI will automatically identify and extract key information from the webpage. You can customize this structure in the next step.

​
Step 3: Customize the JSON Structure (Optional)

  1. Use the interactive JSON editor to modify the structure
  2. Add or remove fields as needed
  3. Rearrange data to match your requirements
  4. Preview the changes in real-time

If you’re happy with the AI-generated structure, you can skip this step and proceed to saving your API.

​
Step 4: Configure API Settings

  1. Under “Saving Options”, decide if you want to enable caching:

    • Enabled: Faster responses, data updated every 15 minutes
    • Disabled: Real-time data, fresh content on every request

  2. Click “Save as API” to create your endpoint

​
Step 5: Get Your API Key

  1. Go to the API Keys section
  2. Copy your unique API key
  3. Keep this key secure - you’ll need it for all API requests

​
Step 6: Use Your New API

Your API endpoint will be in this format:

GET https://api.pulpminer.com/external/{api_id}

To make a request:

curl -H "apikey: YOUR_API_KEY" https://api.pulpminer.com/external/{api_id}

Replace YOUR_API_KEY with your actual API key and {api_id} with the ID of your saved API.

​
Understanding Credit Usage

Each action uses credits:

  • Generating JSON: 1 credit
  • API endpoint request: 2 credits

Monitor your credit usage in the dashboard to ensure uninterrupted service.

​
Next Steps

Now that you’ve created your first API endpoint, you can:

​
Need Help?

If you run into any issues:

  • Check our detailed feature guides in the documentation
  • Contact support at hello@pulpminer.com
  • Visit our GitHub repository for examples and updates