Skip to main content

Browsing the API Catalog and Testing Endpoints

Written by Kadri - RichAPI Support Team

The API Catalog is the RichAPI dashboard page that lists every endpoint your workspace can call. Each card shows the endpoint name, a short description, the category, and the credit price. The Try It button on a card sends a real request from the browser and spends real credits from the workspace.

What does the API Catalog page list?

The API Catalog lists one card for each endpoint that your workspace can call. RichAPI builds the list from the endpoints that your API key unlocks, so two workspaces can see two different lists. The page shows no endpoint that your workspace cannot call. A counter above the cards reads <shown> of <total> apis, and a badge next to it names your plan.

RichAPI API Catalog Grid

Where is the API Catalog page?

  • Sidebar group: API Platform

  • Sidebar item: API Catalog

  • URL: /home/<workspace-slug>/catalog

  • Page title: API Catalog

What does each API Catalog card show?

Element

Example

Description

Category label

ENRICHMENT

The category, with a colored dot in front of it.

Initials block

PE

The initials of the endpoint name.

Endpoint name

Profile Enrichment

The display name of the endpoint.

Description

One or two lines

What the endpoint returns. Longer text is cut after two lines.

Request line

POST /v1/enrich_profile

The method and the path. The full URL is https://api.richapi.ai/api/v1/enrich_profile.

Credit label

1 CREDIT/CALL

The credit price. Read the next section before you run the endpoint.

Try It button

—

Opens the Try It dialog.

View Docs button

—

Opens the endpoint on the in-app Documentation page.

How much does an endpoint in the API Catalog cost?

RichAPI prices an endpoint in one of the shapes below. The shape decides what one call costs, so read it before you run anything. 1 credit costs $0.02 on the 1,000 and 5,000 credit packs, and less on larger packs.

Cost shape

What the card shows

What one call costs

Free

FREE

No credits.

Flat price per call

1 CREDIT/CALL or 5 CREDITS/CALL

The same price for every call, whatever the number of results.

Price per result

0.1 CREDITS/RESULT

The price multiplies by the number of results that the call returns.

Base price plus price per result

10 CREDITS/CALL + 0.5 CREDITS/RESULT

The base price, plus the per-result price times the number of results.

CAUTION: Read the unit on the card before you run an endpoint. A card that ends in /RESULT charges for every result, so a high limit costs more.

What a call costs at four real prices

Endpoint

Price

Results returned

Credits for one call

Cost

Profile Enrichment

1 credit per call

Not applicable

1

$0.02

People Search

0.1 credits per result

100 (limit 100)

10

$0.20

Sitemap Extractor

1 credit per URL returned

50 (limit 50)

50

$1.00

Lead Search

10 credits base, plus 0.5 credits per result

500

260

$5.20

One Profile Enrichment call costs 1 credit. One People Search call that returns 100 results costs 10 credits. That is 10 times the price of the flat-rate call.

How to search, filter, and sort the API Catalog

  1. Open the API Catalog page.

  2. Type a word in the Search APIs... box to narrow the list.

  3. Click a category pill to show only that category.

  4. Click the same pill again, or click All, to clear the category.

  5. Open the sort menu and pick Popular, Lowest Cost, or A-Z.

  6. Read the counter above the cards to confirm how many endpoints match.

The search box matches three things: the endpoint name, the description, and the slug in the request line. The match ignores capital letters.

Control

Options

Default

Category pills

All, then one pill for each category in your list

All

Search box

Free text, placeholder Search APIs...

Empty

Sort menu

Popular, Lowest Cost, A-Z

Popular

The category pills follow a fixed order: Enrichment, Search, Web Scraping, YouTube, Directory, Social, Activity, Email, AI, Ads, Utilities, System. RichAPI shows a pill only for a category that your endpoint list holds. An endpoint in another category, such as Leads, Maps or Funding Data, has no pill. Find it under All or with the search box. Lowest Cost sorts on the number printed on the card, from low to high.

When no endpoint matches, the page shows this text: "No APIs match your search. Try adjusting your filters."

How to run a test call with Try It

CAUTION: Set the limit parameter before you click Run. Try It sends a real request through your API key and spends real credits. The dialog asks for no second confirmation. A per-result endpoint with a high limit costs far more than a flat-price endpoint.

  1. Open the API Catalog page and find the endpoint.

  2. Read the credit label on the card.

  3. Click Try It. The dialog opens.

  4. Check the API Key row. It must show the prefix of an active key.

  5. Fill every parameter marked with a red asterisk.

  6. Set the limit parameter, or any other size parameter, to a small number.

  7. Click Run. The button reads Running… during the call.

  8. Read the status code, the response time, and the credits used.

  9. Read the response under Response body.

What does the Try It dialog show?

Row

Content

Title

The endpoint name, then the description below it.

Request line

POST /v1/<slug>, for example POST /v1/enrich_profile.

Credit badge

The same credit label as the card.

Docs link

View Docs, on the right of the same row.

API Key

The prefix of the oldest active key in the workspace.

Parameters

One field for each parameter of the endpoint.

Run button

Sends the request.

Response

The status code, the response time, the credits used, and the response body.

RichAPI picks the API key for you. The workspace does not choose a key in the dialog. RichAPI uses the oldest active key in the workspace.

Where do the Try It parameters come from?

The parameter fields come from the parameter list of the endpoint. RichAPI builds one field for each parameter and marks a required parameter with a red asterisk after its name.

Parameter type

Field in the dialog

Behavior

Text

A single-line box

The example value shows as a grey hint. Type your own value.

Number

A number box

The example value shows as a grey hint. Type your own number.

True or false

A menu with true and false

The example value is already selected. RichAPI always sends this parameter.

Object or list

A larger box for JSON

The example shape shows as a grey hint. Type valid JSON.

The grey hint is a hint, not a value. RichAPI leaves an empty field out of the request body, so an empty optional field sends no parameter. The Run button stays disabled until every required field holds a value.

How to read the Try It response

Item

What it means

Green status badge

The status code is between 200 and 299. The call succeeded.

Red status badge

The status code is 400 or higher. Read the response for the error.

123ms

The time that the call took.

2 credits

The credits that the call spent. RichAPI hides this line for a call with no reported credit count.

Tree

The response body as a tree. Levels below the second level start closed.

Raw

The response body as formatted JSON text.

Copy

Copies the whole response body. The button reads Copied for two seconds.

RichAPI holds the full price of the call before it starts. A response with a status of 400 or higher charges no credits, because RichAPI returns the whole amount. A per-result call that returns fewer results than the limit charges less than the amount held.

Which endpoints does my workspace see in the API Catalog?

Endpoint access belongs to the organization and the workspace, not to the member.

  • Every customer can call the public endpoints.

  • RichAPI can enable extra endpoints for an organization.

  • RichAPI can block an endpoint for an organization or for one workspace.

An endpoint that your workspace cannot call does not appear on the page at all. There is no locked card and no upgrade prompt. If an endpoint that a colleague names is missing from your API Catalog, the endpoint is not enabled for your workspace.

To ask for access to an endpoint, write to [email protected]. Name the workspace and the endpoint. After RichAPI changes the access of a workspace, the change takes up to five minutes to reach every server. Reload the API Catalog page after five minutes.

If a call reaches a blocked endpoint, RichAPI returns 403 with the message Endpoint not available on your plan. GET /api/v1/my-endpoints lists the endpoints a key can use.

How to run an endpoint from the dashboard home

The dashboard home page carries a smaller runner, named Quick Runner. It runs the same call as Try It and spends the same credits.

  1. Open the Dashboard page at /home/<workspace-slug>.

  2. Find the Quick Runner card.

  3. Click the Select API box and type a name, a category, or a slug.

  4. Pick an endpoint from the grouped list.

  5. Fill the parameters under Parameters & Response.

  6. Click Run.

The Recent Runs card on the right lists your last calls. Click a row to load that endpoint with the same parameters. The Explore card lists endpoints on your plan that you have not tried, each with a Try button.

Where do I find the full parameter and response detail?

The API Catalog card is a summary. It holds no parameter table and no response example.

Question

Where to read the answer

What is every parameter, its type, and its default?

The endpoint article in this help center.

What does the response contain, field by field?

The endpoint article in this help center.

What does a call cost at my volume?

The endpoint article in this help center.

What are the error codes?

The endpoint article in this help center.

How do I call the endpoint from code?

The endpoint article in this help center.

Every RichAPI endpoint has its own article, with a parameter table, a response example, cURL, Python, and Node.js samples, and an error table. The View Docs button on a card opens the in-app Documentation page at /home/<workspace-slug>/docs for the same endpoint.

How to fix a failed Try It call

What you see

Cause

What to do

The Try It button opens a dialog titled API Key Required

The workspace has no active API key.

Click Go to API Keys and create a key.

Create an API key to see your available endpoints. above the cards

The workspace has no active API key.

Click Create API Key.

No active API key found. in the Try It dialog

The workspace has no active API key.

Click Create API Key in the dialog.

The Run button stays grey

A required field is empty, or the workspace has no active key.

Fill every field marked with a red asterisk.

400 with A limit parameter is required for this endpoint.

A per-result endpoint received no limit parameter.

Set the limit parameter, then run the call again.

402 with Insufficient credits

The organization balance is below the reserved amount.

Buy credits, or lower the limit parameter.

402 with Monthly spend limit reached

The workspace reached its monthly spend limit.

Ask the organization owner to raise the workspace's spend limit.

403 with Endpoint not available on your plan

The endpoint is not enabled for the workspace.

Write to [email protected] and name the endpoint.

Network error — please try again.

The browser did not reach RichAPI.

Reload the page and run the call again.

The endpoint is missing from the list

The endpoint is not enabled for the workspace, or a filter hides it.

Clear the search box, click All, then look again.

The credits line is missing under the status badge

RichAPI did not report a credit count for the call.

Open the Usage & Credits page to read the charge.

Frequently asked questions

Does the Try It button in the RichAPI API Catalog spend real credits?

Yes. Try It sends a real request through the API key of the workspace, and RichAPI bills the workspace for it. The dialog asks for no second confirmation, so the call starts as soon as you click Run. Set every limit parameter to a small number first.

Why does one endpoint cost 1 credit and another cost 10 credits per call?

RichAPI prices an endpoint per call or per result. A per-call endpoint charges the same price for every call. A per-result endpoint multiplies its price by the number of results, so a high limit produces a high charge. People Search at a limit of 100 costs 10 credits when it returns 100 results, and Profile Enrichment costs 1 credit.

Why is an endpoint missing from my API Catalog?

The API Catalog lists only the endpoints that your workspace can call. An endpoint that RichAPI does not enable for your workspace is hidden, not locked. Write to [email protected] to ask about access, and name the workspace and the endpoint.

Can I choose which API key the Try It dialog uses?

No. RichAPI picks the oldest active key in the workspace and shows its prefix in the dialog. To change the key that Try It uses, revoke the older key on the API Keys page.

Do I need to type an API key into the Try It dialog?

No. The dialog reads the key of the workspace on the server and never shows the full key. The dialog shows only the key prefix. A direct API call from your own code still needs the x-api-key header.

What does the Lowest Cost sort order use?

Lowest Cost sorts on the credit number printed on each card, from low to high. For a per-result endpoint, that number is the price of one result. A per-result endpoint therefore sorts near the top, even with a full-call price above a flat-price endpoint.

Does a failed Try It call cost credits?

No. RichAPI holds the price of the call before it starts. If the status code is 400 or higher, RichAPI returns the whole amount to the workspace. Only a status code between 200 and 299 charges credits.

Related articles

Did this answer your question?