---
title: "Whether the assistant can answer for this team: a model on the server, the operator's switch, and this month's credits"
method: GET
path: "/assistant"
tags: ["Assistant"]
---

# Whether the assistant can answer for this team: a model on the server, the operator's switch, and this month's credits

`GET /assistant`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/assistant`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Query parameters

- `orgId` string

## Response `200`

Status

- object
  - `organizationId` string, uuid, required
  - `configured` boolean, required: The server has an AI model
  - `enabled` boolean, required: The operator has the assistant switched on
  - `blocked` boolean, required: The operator switched the assistant off for this team
  - `plan` string, required
  - `allowance` object, required
    - `monthlyCredits` number, nullable, required
    - `usedCredits` number, required
    - `remainingCredits` number, nullable, required
    - `periodStart` string, required: ISO-8601 timestamp
    - `resetsAt` string, required: ISO-8601 timestamp
    - `source` 'plan' | 'team' | 'unlimited', required
  - `turnsPerHour` integer, nullable, required: Questions one member may ask per hour; null = no limit
  - `maxMessageLength` integer, required

## Other responses

- `400`: Invalid request (code invalid_request; details.reason secret_detected when a question contains a secret)
- `401`: Not signed in (code unauthorized)
- `403`: Not a dashboard session, or the operator switched the assistant off for this team (details.reason assistant_blocked)
- `404`: Not found, or not your conversation (code not_found)
- `501`: No AI model on this server (code not_configured)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)