Get account details

GET

/v1/account

const url = 'https://api.gopromptless.ai/v1/account';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.gopromptless.ai/v1/account \
  --header 'Authorization: Bearer <token>'

Return the organization associated with your API key. Use it to test a connection and label the account. org_name is null for an organization created before names were recorded.

Authorizations

bearerAuth

Responses

200

The organization associated with the API key.

application/json

AccountResponse

The organization associated with the API key.

object

org_id

required

Org Id

Identifier of the organization the API key belongs to.

string

org_name

required

Org Name

Display name of the organization, or null if none was recorded.

string | null

Example

{
  "org_id": "org_2b5f9c1e",
  "org_name": "Acme, Inc."
}

401

The API key is missing, invalid, or revoked.

application/json

ApiTriggerErrorResponse

Error body returned when an API trigger request is rejected.

object

error

required

Error

Stable machine-readable error code.

string

message

required

Message

Human-readable explanation of the error.

string

Example

{
  "error": "authentication_failed",
  "message": "Authentication failed."
}

503

The read store is temporarily unavailable (runtime_store_unavailable).

application/json

ApiTriggerErrorResponse

Error body returned when an API trigger request is rejected.

object

error

required

Error

Stable machine-readable error code.

string

message

required

Message

Human-readable explanation of the error.

string

Example

{
  "error": "authentication_failed",
  "message": "Authentication failed."
}