---
title: "Get the assistant"
method: GET
path: "/assistant"
tags: ["Assistant"]
---

# Get the assistant

`GET /assistant`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/assistant`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `assistant:write`)

The assistant of the project: its voice, languages, instructions, website and fixed greeting.

## Response `200`

The assistant.

- Assistant: The assistant of the project.
  - `configured` boolean, required: Whether the assistant was ever set up with PUT /assistant.
  - `voice` string, nullable, required: The voice, like ava. It speaks the language.
  - `language` string, required: The language the assistant opens and speaks in, like en.
  - `languages` string[], required: The languages your callers speak, with language first.
  - `speech_recognition` string, required: The language of speech recognition: the one language, or multi when there are two or more.
  - `instructions` string, required: What the assistant does: your instructions.
  - `website` string, nullable, required: The website the assistant reads for opening hours, address and services.
  - `greeting` string, required: The fixed greeting, in the language. It follows from the project name and always says the caller is talking to a digital assistant.
  - `synced_at` string, date-time, nullable, required: When the assistant was last updated at the carrier.

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)