Learn more about Pidgin Intelligence

Pidgin Intelligence gives website owners a simple way to add Nigerian Pidgin translation to websites and digital products without building a translation system from scratch.

What the Pidgin Intelligence does

The API receives translation requests from an approved website, processes the text using the translation service configured by Pidgin Central, and returns the Nigerian Pidgin result to the website.

It is designed for website translation, content localization and visitor-facing English-to-Nigerian-Pidgin experiences.

How website owners can use it

  1. Create a Pidgin Central developer account.
  2. Select a plan that matches your website's expected usage.
  3. Create an API key from the developer dashboard.
  4. Install or configure your website's Pidgin translation client/plugin.
  5. Add the API key and connect the website to Pidgin Intelligence.
  6. Test the translation switch on the live site.

How to get an API key

Open the developer dashboard, create an account, choose a plan and create an API key. Keep the key private and do not expose it in public source code where visitors can copy it.

Your dashboard is also where you can monitor the plan and API access associated with your account.

How to connect a website

  1. Install the Pidgin Central client/translation plugin on the website.
  2. Open its API settings.
  3. Paste the API key generated in your Pidgin Central developer dashboard.
  4. Save and run a translation test.
  5. Enable the visitor language switch when the connection is confirmed.

Available plans and limits

PlanDescriptionLimit
Free For trying the API and small projects. Uses the limits configured for the Free plan.
Starter For websites that need more translation capacity. Uses the limits configured for the Starter plan.
Professional For larger websites and production use. Uses the limits configured for the Professional plan.

Plan names and limits shown here follow the plans configured in the Pidgin Intelligence plugin. Check the developer dashboard for your current account's exact allowance.

API usage examples

Basic translation request

POST /wp-json/pidgin/v1/translate
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "text": "Welcome to our website",
  "source_language": "en",
  "target_language": "pcm"
}

Typical response

{
  "success": true,
  "translation": "Wetin dey happen for our website"
}

The exact REST route and fields depend on the API endpoint exposed by the installed version. Use the endpoint information provided in your developer dashboard/client integration.

How to upgrade to a paid plan

  1. Sign in to your Pidgin Central developer account.
  2. Open the subscription or plans area.
  3. Choose the paid plan you want.
  4. Click Start or Upgrade.
  5. You will be taken to the secure Flutterwave checkout for the selected plan.
  6. Complete payment.
  7. Pidgin Central verifies the transaction before activating the paid plan.

If payment is cancelled or fails, the paid plan is not activated.

Back to Pidgin Central