API Documentation

Utilities

Clean Domain

Normalize a messy URL or domain string to a clean root domain.

POST

/api/v1/clean_domain

0.5 credits per call

Parameters

Field	Type	Required	Description
`messy_url`	string	Yes	URL or domain to normalize (e.g. https://www.Example.COM/page?q=1)

Example response

json

{
  "clean_domain": "acme.com",
  "clean_url": "https://www.acme.com",
  "validated_domain": true
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/clean_domain \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "messy_url": "https://www.acme.com/about?ref=google"
}'

Try it

Count Occurrences

Count how many times a substring appears in a string, with optional case-insensitive matching.

POST

/api/v1/count_occurrences

0.5 credits per call

Parameters

Field	Type	Required	Description
`input`	string	Yes	Input string to search within
`separator`	string	Yes	Substring to split and count by
`case_insensitive`	bool	No	Case-insensitive matching (default false)
`limit`	int	No	Max results to return (0 for all, max 1000)

Example response

json

{
  "results": [
    {
      "count": 2,
      "item": "foo"
    },
    {
      "count": 1,
      "item": "bar"
    },
    {
      "count": 1,
      "item": "baz"
    }
  ],
  "total_items": 4,
  "unique_items": 3
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/count_occurrences \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "foo,bar,foo,baz",
  "separator": ",",
  "case_insensitive": true,
  "limit": 10
}'

Try it

Distribute Leads

Round-robin distribute leads across a set of assignment labels (e.g. sales reps).

POST

/api/v1/distribute_leads

0.5 credits per call

Parameters

Field	Type	Required	Description
`assignment_labels`	string	No	Comma-separated assignment labels (e.g. Team A,Team B,Team C)
`values_associated_with_labels`	string	Yes	Comma-separated values to distribute (e.g. alice@co.com,bob@co.com)
`current_index`	int	No	Starting index for round-robin (default 0)

Example response

json

{
  "assignments": [],
  "next_index": 1
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/distribute_leads \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "assignment_labels": "Team A,Team B,Team C",
  "values_associated_with_labels": "alice@co.com,bob@co.com,carol@co.com",
  "current_index": 0
}'

Try it

Encode URI

URL-encode a string for safe use in query parameters or path segments.

POST

/api/v1/encode_uri

0.5 credits per call

Parameters

Field	Type	Required	Description
`value`	string	Yes	String to URL-encode (RFC 3986)

Example response

json

{
  "encoded": "example"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/encode_uri \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "value": "hello world & foo=bar"
}'

Try it

Extract URLs & Emails

Extract all URLs and email addresses from a block of text.

POST

/api/v1/extract_urls_emails

0.5 credits per call

Parameters

Field	Type	Required	Description
`text`	string	Yes	Text block to extract URLs and emails from

Example response

json

{
  "emails": [],
  "urls": []
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/extract_urls_emails \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Contact us at hello@acme.com or visit https://acme.com"
}'

Try it

Find Redirect

Follow a URL through all redirects and return the final destination URL.

POST

/api/v1/find_redirect

1 credit per call

Parameters

Field	Type	Required	Description
`link`	string	Yes	URL to follow through all redirects to the final destination

Example response

json

{
  "final_url": "example",
  "redirect_chain": [],
  "status_code": 1
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/find_redirect \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "link": "https://bit.ly/example"
}'

Try it

Find Sitemap URLs

Discover and filter URLs from a domain's sitemap by keyword.

POST

/api/v1/find_sitemap_urls

1 credit per call

Parameters

Field	Type	Required	Description
`domain`	string	Yes	Domain to discover sitemap URLs from (e.g. stripe.com)
`keywords`	string	No	Comma-separated keywords to filter URLs
`exact_match`	bool	No	Match keywords exactly (default false)

Example response

json

{
  "total": 1,
  "urls": []
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/find_sitemap_urls \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "stripe.com",
  "keywords": "pricing",
  "exact_match": true
}'

Try it

Format Datetime

Parse and reformat a date/time string with optional timezone conversion and locale.

POST

/api/v1/format_datetime

0.5 credits per call

Parameters

Field	Type	Required	Description
`date`	string	Yes	Date/time string to parse (ISO 8601 or common formats)
`format`	string	No	strftime format string for output (e.g. %B %d, %Y)
`original_timezone`	string	No	Timezone of the input date (e.g. UTC)
`new_timezone`	string	No	Target timezone for output (e.g. America/New_York)
`locale`	string	No	Locale for month/day names (e.g. en, fr)

Example response

json

{
  "formatted": "example",
  "iso": "example",
  "timezone": "example"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/format_datetime \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "date": "2026-04-11T14:30:00Z",
  "format": "%B %d, %Y",
  "original_timezone": "example",
  "new_timezone": "America/New_York",
  "locale": "example"
}'

Try it

Identify Email Type

Classify an email address as personal, business, role-based, or disposable.

POST

/api/v1/identify_email_type

0.5 credits per call

Parameters

Field	Type	Required	Description
`email`	string	Yes	Email address to classify

Example response

json

{
  "domain": "example",
  "type": "example"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/identify_email_type \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "john.doe@gmail.com"
}'

Try it

Normalize Company

Clean and normalize a company name by removing legal suffixes, extra whitespace, and punctuation.

POST

/api/v1/normalize_company

0.5 credits per call

Parameters

Field	Type	Required	Description
`company_name`	string	Yes	Company name to normalize (e.g. ACME TECHNOLOGIES, INC.)
`normalize_case`	bool	No	Convert to title case (default true)

Example response

json

{
  "normalized": "example"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/normalize_company \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "company_name": "ACME TECHNOLOGIES, INC.",
  "normalize_case": true
}'

Try it

Normalize List

Split a delimited string into a clean list, optionally removing empty values.

POST

/api/v1/normalize_list

0.5 credits per call

Parameters

Field	Type	Required	Description
`input`	string	Yes	Delimited string to split and deduplicate
`remove_empty_values`	bool	No	Remove empty items after splitting (default false)

Example response

json

{
  "list": []
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/normalize_list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "apple, Banana, apple, , cherry",
  "remove_empty_values": true
}'

Try it

Normalize Phone

Parse and normalize a phone number to E.164 format with optional country code hint.

POST

/api/v1/normalize_phone

0.5 credits per call

Parameters

Field	Type	Required	Description
`phone_number`	string	Yes	Phone number to normalize (any format)
`country_code`	string	No	ISO country code hint (e.g. US)

Example response

json

{
  "country": "example",
  "e164": "example",
  "national": "example",
  "valid": true
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/normalize_phone \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "(415) 555-1234",
  "country_code": "US"
}'

Try it

Predict Gender

Predict the gender of a person from their first name.

POST

/api/v1/predict_gender

1 credit per call

Parameters

Field	Type	Required	Description
`name`	string	Yes	First name to predict gender for

Example response

json

{
  "confidence": 1,
  "gender": "example"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/predict_gender \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Jordan"
}'

Try it

Remove Whitespace

Strip and collapse extra whitespace from a string.

POST

/api/v1/remove_whitespace

0.5 credits per call

Parameters

Field	Type	Required	Description
`input_text`	string	Yes	String to strip and collapse whitespace from

Example response

json

{
  "output": "example"
}

Code

curl -X POST https://dev-api.richapi.ai/api/v1/remove_whitespace \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input_text": "  hello   world  "
}'

Try it