Account

Get Account

Retrieves account details

get/v1/Account

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Account/get.ts
A function with typed inputs. Its response is checked against the schema.

Client information

namestring nullable

The name of the client.

totalAgentsinteger

The total number of agents.

creditBalancenumber double

The current credit balance.

statusinteger

Represents the authorization status for making calls.

1 - FullAccess

2 - LimitedAccess

3 - NoCredits

4 - SuspendedAccount

5 - DebtReached

No recorded changes to this operation across all 1 revision of this API.