RichAPI answers live in four places: this Help Center at https://help.richapi.ai, the API reference at https://app.richapi.ai/docs (the Documentation page in the dashboard), the API Catalog in the dashboard, and the status page at https://status.richapi.ai. The API reference holds the base URL, the billing rules, the error codes, and every endpoint, and you can download it as an OpenAPI document. This Help Center holds one article for each endpoint. For anything these places do not answer, send a message in the chat in the dashboard, or write to [email protected].
Where does RichAPI documentation live?
Place | URL | What it is for |
Help Center | One article per endpoint, plus the dashboard articles: the full parameter table, the response fields, the credit arithmetic, and the errors. | |
In-dashboard documentation |
| The API reference for the endpoints your workspace can call, with parameters, example responses, code samples, and a Test Request button. |
Public documentation | The same reference, signed out, limited to the public endpoints. It is read-only. | |
OpenAPI spec | The API reference as an OpenAPI document in JSON. Add | |
API Catalog |
| A card for each endpoint your workspace can call, with its credit price and a Try It button. |
Status page | The current status of the RichAPI service. Check it first when calls fail for everyone. | |
Support | The chat in the dashboard, or [email protected] | Anything the places above do not answer. |
What is in the in-dashboard Documentation page?
The in-dashboard Documentation page is the API reference that RichAPI builds from your own endpoint list. It shows only the endpoints that your workspace can call. The page title is API Documentation.
Section | What the section holds |
Getting Started | The base URL, the |
Credits & Pricing | The billing rules, a usage call, the usage response, and the rate limit rule. |
Plans and credits | How plan credits and add-on credits pay for a call, and the billing error codes. |
Error Handling | The HTTP status codes, whether each code bills credits, the error shape, the common errors, and a retry example. |
One group per endpoint category | For example Enrichment, Search, Waterfall, and Web Scraping. Each endpoint shows its credit price, its parameters, an example response, code samples, and a Test Request button. |
How to navigate the in-dashboard Documentation page
Open the RichAPI dashboard.
Click Documentation in the API Platform group of the sidebar.
Click a section or an endpoint in the left sidebar of the reference, or search for it there.
To send a live call, open an endpoint and click Test Request. The call runs for your workspace and spends real credits.
To take the reference into another tool, click Export at the top of the page.
The Export menu holds Download JSON and Download YAML (the OpenAPI document), Copy link for Postman import, and Download Markdown.
Can I read the RichAPI documentation without signing in?
Yes. The same Documentation page is readable at https://app.richapi.ai/docs with no account and no API key. When you are signed out, two things change.
What changes | Signed in at | Signed out at |
Endpoint list | Every endpoint your workspace can call, including any private endpoint that RichAPI grants to it. | The public endpoints only. |
Test Request button | Sends a real call for your workspace and spends credits. | Hidden. The page header reads "Sign in to try requests live — this reference is read-only." |
Everything else on the page is the same: the guides, the parameters, the example responses, the code samples, and the Export menu.
How does the in-dashboard documentation differ from this Help Center?
The in-dashboard documentation is a quick reference next to a runnable call. This Help Center is the deep reference. Each RichAPI endpoint has one article here.
Topic | In-dashboard documentation | This Help Center |
Parameters | Field, type, required flag, and description. | The same, plus the default value of every parameter. |
Response | An example response. | An example response, plus a table of every response field. |
Credit cost | The credit price on the endpoint. | The credit price, plus the arithmetic for a real call volume. |
Code samples | Generated from the reference for the endpoint. | cURL, Python, and Node.js. |
Errors | One shared Error Handling section for the whole API. | An error table for that one endpoint. |
Run a call | Yes, with Test Request. | No. |
Where do I look for what?
What you need | Where to look |
A parameter name, its type, or its default | The endpoint article in this Help Center. |
A response field | The endpoint article in this Help Center. |
What one call costs | The endpoint article, or the credit label on the API Catalog card. |
Why a call failed | The errors table in the endpoint article. |
A code sample to paste | The endpoint article, or the endpoint on the Documentation page. |
The OpenAPI document | https://app.richapi.ai/api/openapi, or Export on the Documentation page. |
Whether RichAPI is up | |
The endpoints your workspace can call | The API Catalog page. |
A credit balance, an invoice, or a payment question | The credits articles in this Help Center. |
Anything else | The chat in the dashboard, or [email protected] |
Where do I see what my workspace can call?
The API Catalog is the dashboard page that lists every endpoint your workspace can call. Each card names the endpoint, its category, and its credit price. The Try It button on a card sends a real request and spends real credits.
CAUTION: Set every limit parameter to a small number before you click Run in Try It. The call spends real credits from the workspace. RichAPI asks for no second confirmation.
An endpoint that your workspace cannot call is hidden from the API Catalog. There is no locked card. An organization owner can block or unblock endpoints for each team on the Organization page, under Teams and Manage access. To ask RichAPI for access to an endpoint, contact support and name the workspace and the endpoint.
Browsing the API Catalog and Testing Endpoints covers the search, the sort order, the price shapes, and the full Try It walkthrough.
How do I contact RichAPI support?
Search this Help Center at https://help.richapi.ai first. If it does not answer your question, use one of two channels:
The chat in the dashboard. Sign in at https://app.richapi.ai and click the chat button at the bottom right of any dashboard page. The chat knows which account you are signed in to.
Email. Write to [email protected].
A message with the five items below gets an answer on the first reply. A message with none of them starts a round of questions first.
Item | Where to find it |
The endpoint name | The path of the call, for example |
The time of the call | The Usage & Credits page. The call log lists each call with its time. |
The status code | The response of the call, or the Status column of the call log. |
The request id | The |
The workspace | The workspace name in the switcher at the top of the sidebar. |
RichAPI returns a request id on every API response, in the X-Correlation-Id header and in richapi_meta.request_id in the body. That value identifies your exact call in the RichAPI logs. If you have it, paste it into the message.
Open the Usage & Credits page and find the failed call.
Read its time, its status code, and its endpoint name.
If your client stored the
X-Correlation-Idheader value, copy it.Send those items and the request body you sent in the dashboard chat, or write to [email protected].
Remove your API key from anything you paste.
CAUTION: Never paste a full API key into a support message. If a key reached a message or a log, revoke that key on the API Keys page. Then create a new key.
Frequently asked questions
Where is the RichAPI API documentation?
RichAPI documentation is on the Documentation page of the dashboard, at /home/<account-slug>/docs. The same reference is readable without an account at https://app.richapi.ai/docs, and the OpenAPI document is at https://app.richapi.ai/api/openapi. This Help Center at https://help.richapi.ai adds one article for each endpoint, with the full parameter table and the credit arithmetic.
Do I need an account to read the RichAPI documentation?
No. The documentation at https://app.richapi.ai/docs needs no account and no API key. It lists the public endpoints. The Test Request button is the only part that needs a sign-in, because a live call runs for a workspace and spends its credits.
Why does my colleague see an endpoint that I cannot find in the documentation?
The Documentation page and the API Catalog list only the endpoints that your workspace can call. Endpoint access belongs to the workspace, not to the member. A colleague in a different workspace can see a different list. An organization owner can change the blocked endpoints of a team on the Organization page. To ask RichAPI for access, contact support.
Where can I check whether RichAPI is down?
Open the status page at https://status.richapi.ai. If the status page shows no problem and your calls still fail, contact support with the items in the section above.
Does RichAPI give me a request id for a failed call?
Yes. Every API response carries an X-Correlation-Id header, and that value is the request id of the call. The call log export carries the same value in its request_id column. Quote it in a support message.
How do I contact RichAPI support?
Use the chat button at the bottom right of any dashboard page, or write to [email protected]. Name the endpoint, the time of the call, the status code, and the request id in the message. Never include an API key.
Where do I read the credit price of an endpoint?
Three places show the credit price of an endpoint. The API Catalog card prints it, and the Documentation page shows it on each endpoint. The endpoint article in this Help Center shows it with the arithmetic. 1 credit costs $0.02 on the 1,000 and 5,000 credit packs, and less on larger packs.
Related articles