Instance status REST API

GET

/api/status

const url = 'https://hitkeep.com/api/status';
const options = {method: 'GET'};

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://hitkeep.com/api/status

Setup and version status, plus optional managed-cloud metadata.

Responses

200

Status payload

application/json

object

ask_ai

object

available

required

boolean

budget_exhausted

required

boolean

enabled

required

boolean

model

string

provider

string

status

required

string

Allowed values: disabled not_configured available budget_exhausted

cloud

object

hosted

boolean

jurisdiction

string

region

string

signup_enabled

boolean

support_url

string

upgrade_url

string

needs_setup

boolean

version

string

Example

{
  "ask_ai": {
    "status": "disabled"
  }
}