Overview
Pig Latin uses the pig-latinizer library to translate `text`. Words are split on whitespace, slashes, underscores and dashes. A word that begins with a consonant has its leading consonant cluster moved to the end followed by "ay", so "packed" becomes "ackedpay"; a word that begins with a vowel gets "yay" appended, so "is" becomes "isyay". Y is treated as a consonant at the start of a word and as a vowel elsewhere. Accented letters stay inside their word and count as their base letter, so "café" becomes "afécay" and "Émile" becomes "Émileyay"; words in non-Latin scripts are passed through unchanged.
Capitalization is carried over to the translated word, so "The" becomes "Ethay" and an all-caps word stays all caps. Punctuation, spaces, tabs and line breaks are preserved in place. Apostrophes inside contractions and possessives are removed so "don't" translates cleanly, and when a translation would end in a hard-to-read repeated consonant the library inserts a hyphen. Tokens with no sensible Pig Latin form, such as words containing digits, are passed through unchanged.
`exclusions` is an optional array of strings. Each entry must be a string; any other type returns a 400 error naming the bad index. Entries are trimmed and duplicates removed, and each remaining entry is added to the translator's exclusion list so matching words are output untranslated. Matching is case-sensitive: excluding "world" does not protect "World", so list each casing you need. The cleaned list is echoed back as `exclusions`, or as an empty array when none were sent. `text` in the response holds the translated string. There are no plan-dependent fields.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl -X POST https://api.apiverve.com/v1/piglatin \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"text": "The square wooden crate was packed to be shipped. To have is better than to wait and hope.",
"exclusions": [
"crate",
"hope"
]
}'const res = await fetch('https://api.apiverve.com/v1/piglatin', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"text": "The square wooden crate was packed to be shipped. To have is better than to wait and hope.",
"exclusions": [
"crate",
"hope"
]
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/piglatin",
headers={"x-api-key": "your_api_key_here"},
json={
"text": "The square wooden crate was packed to be shipped. To have is better than to wait and hope.",
"exclusions": [
"crate",
"hope"
]
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"text": "The square wooden crate was packed to be shipped. To have is better than to wait and hope.",
"exclusions": [
"crate",
"hope"
]
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/piglatin", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
textRequired | string | The text to encode in Pig Latin |
exclusionsOptional | array | Words to exclude from encoding |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"text": "Ethay uaresqay oodenway crate asway ackedpay otay ebay ippedshay. Otay avehay isyay etterbay anthay otay aitway andyay hope.",
"exclusions": [
"crate",
"hope"
]
}
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
text | string | "Ethay uaresqay oodenway crate asway ackedpay otay ebay ippedshay. Otay avehay isyay etterbay anthay…" | Text encoded in Pig Latin format |
exclusions | array | [crate, ...] | The words left untranslated, echoed back after trimming and de-duplication |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Word Game Mechanics
- Word game developers transform clues or puzzle prompts into Pig Latin while keeping player names and brand terms intact.
- Chat Filter Plugins
- Social messaging platforms offer playful message filters that translate conversational dialogue on demand before posting to a room.
- Linguistics Practice Tools
- To teach phonetics and syllable structures, reading software converts sample vocabulary while protecting punctuation and specific instructional terms.
- Spoiler Text Obfuscation
- Obfuscate plot spoilers in community discussion boards so readers must decode the Pig Latin sentences manually to see details.
Other ways to use Pig Latin
Set up Pig Latin on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Text Processing: