Return minimal details for the current token

GET

/api/v1/ping

const url = 'https://app.prefactorai.com/api/v1/ping';
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://app.prefactorai.com/api/v1/ping \
  --header 'Authorization: Bearer <token>'

Authorizations

authorization

Parameters

Query Parameters

idempotency_key

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

details

object

account_id

Account ID

string

admin_user_id

Admin user ID

string

agent_deployment_id

Agent deployment ID

string

agent_id

Agent ID

string

api_token_id

API token ID

string

environment_id

Environment ID

string

superadmin_user_id

Superadmin user ID

string

token_type

required

Auth token type

string

status

string

Allowed values: success

Example

{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "admin_user_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "agent_deployment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "agent_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "api_token_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "environment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "superadmin_user_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny"
  },
  "status": "success"
}

default

Error

application/json

One of:

object
object

object

code

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used

message

string

status

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}