Setup

Create a new “Usage Product” from the UI

Create a new “Usage Product” on the app and select the “Connect API” option.

Verify Usage Product

The product will be marked as "Not connected" until verification by using verification API (see below). Hovering on the “Not Connected” text will suggest copying the verification code for sending it to your IT team.

Execution of this simple command by the IT will mark the product as "Connected".

An example of the verification code -

GET <https://api.received.ai/usage/verify?id=**{{usage_product_id}>}**

URL Parameters:

id string

The “usage product id” you want to verify.

How to add a new usage report using API

Login

POST <https://api.received.ai/auth/login>

{
  "email": "{{admin_email}}",
  "password": "{{admin_password}}"
}

Body Parameters:

email string

The user’s email address

password string