/api/v1/ai/status

GET

/api/v1/ai/status

const url = 'https://example.com/api/v1/ai/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://example.com/api/v1/ai/status

Parameters

Query Parameters

locationId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

resolved

required

boolean

source

required

Any of:

string
null

string

Allowed values: instance account user

providerKind

required

Any of:

string
null

string

Allowed values: openai anthropic google openai_compatible openrouter groq

model

required

string | null

pausedUntil

required

string | null

reason

required

Any of:

string
null

string

Allowed values: manual cap_money cap_tokens tokens_day

pausedBy

required

Any of:

object
null

object

scope

required

string

label

required

string

waitingProvider

required

Any of:

object
null

object

until

required

string

reason

required

string

Allowed values: rate_limited limits provider_down auth

capPercent

required

number | null

canResume

required

boolean

canManage

required

boolean

manager

required

Any of:

object
null

object

displayName

required

string

modelMissing

required

boolean

embeddingsSource

string

Allowed values: provider local off

Example

{
  "source": "instance",
  "providerKind": "openai",
  "reason": "manual",
  "waitingProvider": {
    "reason": "rate_limited"
  },
  "embeddingsSource": "provider"
}