Hypamoon Assistant API

openapi: 3.2.0
info:
  title: Hypamoon Assistant API
  version: 1.0.0
  description: 'Hypamoon is the infrastructure a chat or an agent builds on for a business: sites and apps (with server code, sign-in and their own database), data and forms, a media library, domains, email from your own domain, phone numbers with voice AI, SMS and chat, payments (see https://hypamoon.com/docs/payments) and agents. The same project is reachable from a connected chat over MCP and from your own code over this REST API.


    Calls are inbound, plus outbound calls your assistant makes to people who expect them (POST /calls).


    Every request needs an API key: `Authorization: Bearer hm_live_...`, or `hm_test_...` in test mode. Each key has scopes and a rate limit of 120 requests per 60 seconds.


    An OAuth access token (`hm_oat_...`, from connecting an assistant such as Claude.ai or ChatGPT) works on every /api/v1 route as well, with the scopes the user granted on the consent screen. For your own app, create an API key in the portal instead.


    Every error is `application/problem+json` with a `type` URL that explains the fix (`https://hypamoon.com/docs/errors/`). Every response carries an `X-Request-Id` header; include it when you ask us for help.


    Field names are snake_case, except inside a call plan, which is stored exactly as you send it (camelCase). New fields may be added to a response at any time; renaming or removing one requires a new version.'
  contact:
    name: Hypamoon support
    url: https://hypamoon.com/docs
servers:
- url: https://api.hypamoon.com/api/v1
security:
- ApiKey: []
- OAuth2: []
tags:
- name: Assistant
  description: The voice AI that answers your calls. One per project.
paths:
  /assistant:
    get:
      operationId: getAssistant
      tags:
      - Assistant
      summary: Get the assistant
      description: 'The assistant of the project: its voice, languages, instructions, website and fixed greeting.'
      x-hypamoon-scope: assistant:write
      security:
      - ApiKey:
        - assistant:write
      - OAuth2:
        - assistant:write
      responses:
        '200':
          description: The assistant.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Assistant'
              example:
                configured: true
                voice: ava
                language: en
                languages:
                - en
                speech_recognition: en
                instructions: You answer for Acme Plumbing. Ask for the address and the problem, and tell the caller we call back within the hour. Never quote prices.
                website: https://acme-plumbing.example/
                greeting: You are speaking with the digital assistant of Acme Plumbing. How can I help you?
                greeting_custom: false
                synced_at: '2026-10-01T09:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    put:
      operationId: putAssistant
      tags:
      - Assistant
      summary: Set the assistant
      description: 'One assistant per project. PUT replaces all fields; any field you leave out reverts to its default. greeting is the exception: leave it out and it stays. Your own greeting must say the caller is talking to an AI (EU AI Act, article 50); without that we put a short disclosure in front and return warnings. Without your own greeting, the default comes from your project name and the language.'
      x-hypamoon-scope: assistant:write
      security:
      - ApiKey:
        - assistant:write
      - OAuth2:
        - assistant:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssistantInput'
            example:
              language: en
              voice: ava
              instructions: You answer for Acme Plumbing. Ask for the address and the problem, and tell the caller we call back within the hour. Never quote prices.
              website: https://acme-plumbing.example
      responses:
        '200':
          description: The assistant as saved.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssistantSaved'
              example:
                configured: true
                voice: ava
                language: en
                languages:
                - en
                speech_recognition: en
                instructions: You answer for Acme Plumbing. Ask for the address and the problem, and tell the caller we call back within the hour. Never quote prices.
                website: https://acme-plumbing.example/
                greeting: You are speaking with the digital assistant of Acme Plumbing. How can I help you?
                greeting_custom: false
                synced_at: '2026-10-01T09:00:00.000Z'
                sync: synced
                call_plan: added
                next_step: 'The project''s main call plan was changed: it only had the default plan (voicemail), so now the assistant answers every call, and callers can leave a message if it is not available. Nothing else is needed. To ring a team first, PUT /numbers/{id}/call-plan.'
                user_message: Your assistant is ready, and your call plan now sends every call to it. If it is ever not available, callers can leave a message.
        '400':
          description: 'Bad Request: invalid_json.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - invalid_json
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/invalid_json
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: 'Conflict: version_conflict.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - version_conflict
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/version_conflict
        '422':
          description: 'Unprocessable Content: validation_failed.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          x-hypamoon-errors:
          - validation_failed
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Problem'
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - https://hypamoon.com/docs/errors/validation_failed
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: 'A URL that explains the error and the fix: https://hypamoon.com/docs/errors/<slug>.'
        title:
          type: string
          description: The HTTP status in words.
        status:
          type: integer
          description: The HTTP status.
        detail:
          type: string
          description: What went wrong in this request.
        request_id:
          type: string
          description: The id of this request, also in the X-Request-Id header. Mention it when you contact support.
        user_message:
          type: string
          description: One calm sentence in plain English for the end user, without technical terms. A chat or app can show it as it is.
        next_step:
          type: string
          description: 'With some errors: what the chat or agent itself should do next.'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
          description: 'With validation_failed, schema_mismatch and team_targets_not_allowed: every problem.'
        missing:
          type: array
          items:
            type: string
          description: 'With company_details_missing: the missing fields, as paths of PUT /project/company.'
        current_version:
          anyOf:
          - type: integer
          - type: string
          description: 'With version_conflict: the version that is there now (a number on a call plan, a string on a site; send it as if_match_version).'
        spend_cap_eur:
          type: number
          description: 'With billing_blocked: the spending cap per calendar month.'
        spent_eur:
          type: number
          description: 'With billing_blocked: what was spent this calendar month.'
        balance_eur:
          type: number
          description: 'With insufficient_balance: the prepaid balance now.'
        required_eur:
          type: number
          description: 'With insufficient_balance: what this request costs.'
        auto_reload_started:
          type: boolean
          description: 'With insufficient_balance: true when an automatic top-up just started; retry in a minute.'
      required:
      - type
      - title
      - status
      - detail
      - request_id
      - user_message
      description: An error, as application/problem+json (RFC 9457).
    AssistantInput:
      type: object
      properties:
        voice:
          type: string
          enum:
          - saar
          - fenna
          - merel
          - julia
          - roos
          - tim
          - bram
          - daan
          - ruben
          - ava
          - nora
          - liam
          - owen
          - lena
          - mara
          - jonas
          - felix
          - chloe
          - manon
          - hugo
          - theo
          - lucia
          - elena
          - pablo
          - diego
          description: 'The voice. It must speak the language: nl saar, fenna, merel, julia, roos, tim, bram, daan, ruben; en ava, nora, liam, owen; de lena, mara, jonas, felix; fr chloe, manon, hugo, theo; es lucia, elena, pablo, diego. Case does not matter. Default: the first voice of the language.'
        language:
          type: string
          enum:
          - nl
          - en
          - de
          - fr
          - es
          description: 'The language the assistant opens and speaks in: en (English), nl (Dutch), de (German), fr (French) or es (Spanish). The greeting follows it. Default: the language of the country of your first number (Dutch while the project has no number yet).'
        languages:
          type: array
          items:
            type: string
            enum:
            - nl
            - en
            - de
            - fr
            - es
          minItems: 1
          maxItems: 5
          description: 'The languages your callers speak; language always comes first. One language is the most reliable, because speech recognition never has to guess. Two or more switch it to multi, which follows the caller sentence by sentence, and the assistant switches with them. auto and multi are not accepted. Default: [language].'
        instructions:
          type: string
          maxLength: 4000
          description: What the assistant does, as free text. Default empty.
        website:
          type:
          - string
          - 'null'
          description: Optional. We read the page and use it for opening hours, address and services. Must be a public web address.
        greeting:
          type:
          - string
          - 'null'
          maxLength: 300
          description: 'Optional. The first sentence callers hear, in the language set by language, at most 300 characters; keep it short, callers can only speak after it. It must say the caller is talking to an AI (EU AI Act, article 50), like "digital assistant", "virtual assistant" or "AI": if it does not, we put a short disclosure in front and say so in warnings. null or an empty string goes back to the default greeting. Unlike the other fields, leaving it out keeps the greeting you have.'
      additionalProperties: false
      description: 'PUT replaces all fields: a field you leave out goes back to its default.'
    Assistant:
      type: object
      properties:
        configured:
          type: boolean
          description: Whether the assistant was ever set up with PUT /assistant.
        voice:
          type:
          - string
          - 'null'
          description: The voice, like ava. It speaks the language.
        language:
          type: string
          description: The language the assistant opens and speaks in, like en.
        languages:
          type: array
          items:
            type: string
          description: The languages your callers speak, with language first.
        speech_recognition:
          type: string
          description: 'The language of speech recognition: the one language, or multi when there are two or more.'
        instructions:
          type: string
          description: 'What the assistant does: your instructions.'
        website:
          type:
          - string
          - 'null'
          description: The website the assistant reads for opening hours, address and services.
        greeting:
          type: string
          description: The first sentence callers hear. Your own (greeting on PUT), or the default that follows from the project name and the language. It always says the caller is talking to a digital assistant.
        greeting_custom:
          type: boolean
          description: true when greeting is your own text; false for the default.
        synced_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the assistant was last updated at the carrier.
      required:
      - configured
      - voice
      - language
      - languages
      - speech_recognition
      - instructions
      - website
      - greeting
      - greeting_custom
      - synced_at
      additionalProperties: false
      description: The assistant of the project.
    AssistantSaved:
      type: object
      properties:
        configured:
          type: boolean
          description: Whether the assistant was ever set up with PUT /assistant.
        voice:
          type:
          - string
          - 'null'
          description: The voice, like ava. It speaks the language.
        language:
          type: string
          description: The language the assistant opens and speaks in, like en.
        languages:
          type: array
          items:
            type: string
          description: The languages your callers speak, with language first.
        speech_recognition:
          type: string
          description: 'The language of speech recognition: the one language, or multi when there are two or more.'
        instructions:
          type: string
          description: 'What the assistant does: your instructions.'
        website:
          type:
          - string
          - 'null'
          description: The website the assistant reads for opening hours, address and services.
        greeting:
          type: string
          description: The first sentence callers hear. Your own (greeting on PUT), or the default that follows from the project name and the language. It always says the caller is talking to a digital assistant.
        greeting_custom:
          type: boolean
          description: true when greeting is your own text; false for the default.
        synced_at:
          type:
          - string
          - 'null'
          format: date-time
          description: When the assistant was last updated at the carrier.
        sync:
          type: string
          enum:
          - synced
          - failed
          - skipped_test_mode
          description: 'synced when the assistant was updated right away; failed when not. Your settings are saved either way and applied with the next PUT. skipped_test_mode with a test key: a test project has no live assistant.'
        call_plan:
          type: string
          enum:
          - added
          - in_plan
          - not_in_plan
          description: 'added: the project only had the default plan (voicemail), so it now has a call plan where the assistant answers every call, with voicemail if the assistant is not available. in_plan: the call plan already sends calls to the assistant. not_in_plan: your own call plan does not use the assistant yet; add an ai_agent node with PUT /numbers/{id}/call-plan.'
        next_step:
          type: string
          description: What to do next.
        user_message:
          type: string
          description: A sentence you can show the user as it is.
        warnings:
          type: array
          items:
            type: string
          description: 'Only when something was adjusted, like a greeting without the AI disclosure: we put a short disclosure in front. Tell the user and offer to choose their own wording.'
      required:
      - configured
      - voice
      - language
      - languages
      - speech_recognition
      - instructions
      - website
      - greeting
      - greeting_custom
      - synced_at
      - sync
      - call_plan
      - next_step
      - user_message
      additionalProperties: false
      description: The assistant as saved.
    FieldError:
      type: object
      properties:
        path:
          type: string
          description: Where the problem is, with dots, like address.postal_code. body means the body as a whole.
        message:
          type: string
          description: What is wrong, in English.
      required:
      - path
      - message
      additionalProperties: false
  responses:
    Unauthorized:
      description: 'Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, api_key_expired, project_deleted.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      x-hypamoon-errors:
      - unauthorized
      - missing_api_key
      - invalid_api_key
      - api_key_revoked
      - api_key_expired
      - project_deleted
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/unauthorized
                  - https://hypamoon.com/docs/errors/missing_api_key
                  - https://hypamoon.com/docs/errors/invalid_api_key
                  - https://hypamoon.com/docs/errors/api_key_revoked
                  - https://hypamoon.com/docs/errors/api_key_expired
                  - https://hypamoon.com/docs/errors/project_deleted
    InternalError:
      description: 'Internal Server Error: internal_error.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      x-hypamoon-errors:
      - internal_error
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/internal_error
    ServiceUnavailable:
      description: 'Service Unavailable: service_unavailable.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      x-hypamoon-errors:
      - service_unavailable
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/service_unavailable
    Forbidden:
      description: 'Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, ip_not_allowed, verification_required.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      x-hypamoon-errors:
      - project_not_enabled
      - key_mode_mismatch
      - missing_scope
      - ip_not_allowed
      - verification_required
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/project_not_enabled
                  - https://hypamoon.com/docs/errors/key_mode_mismatch
                  - https://hypamoon.com/docs/errors/missing_scope
                  - https://hypamoon.com/docs/errors/ip_not_allowed
                  - https://hypamoon.com/docs/errors/verification_required
    RateLimited:
      description: 'Too Many Requests: rate_limited.'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      x-hypamoon-errors:
      - rate_limited
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/Problem'
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - https://hypamoon.com/docs/errors/rate_limited
  headers:
    X-Request-Id:
      schema:
        type: string
      description: The id of this request. Include it when you contact support.
    Retry-After:
      schema:
        type: integer
      description: Seconds to wait before you try again.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: hm_live_..., hm_test_..., or an OAuth access token hm_oat_...
      description: 'Your API key as a bearer token: `Authorization: Bearer hm_live_...`. Live keys start with hm_live_; test keys start with hm_test_, belong to a test project, never reach the carrier and cost nothing. A key has scopes (project:read, project:write, numbers:read, calls:read, numbers:write, assistant:write, webhooks:write, messages:read, messages:write, calls:write, chat:read, chat:write, sites:read, sites:write, data:read, data:write); each operation names the one it needs in x-hypamoon-scope. Keys are shown only once; store them as a secret, never in a frontend. An OAuth access token (hm_oat_..., see OAuth2) is sent the same way and works on every /api/v1 route.'
    WordPressToken:
      type: http
      scheme: bearer
      bearerFormat: hm_wp_...
      description: Only for the /wordpress routes of the Hypamoon Connect plugin for WordPress. The plugin gets this token once, with POST /wordpress/connect and a one-time code, and sends it with X-Hypamoon-Site (the address of the WordPress site). It can only send this site's inventory and the data the user selected, to one project, for 30 days, and it can be revoked. It is not an API key.
    PublicChatToken:
      type: apiKey
      in: query
      name: token
      description: 'Only for the /public routes of the chat widget. The public chat token (hm_pub_... or hm_pubtest_...) in the query string, from a browser page on one of the token''s allowed origins (the Origin header must match exactly). It is not a secret: it is in the page source of your website. It can only chat, only from those origins, with a bot check and its own limits, and you can revoke it. Create one with POST /chat-tokens or in the portal. Never send your API key from a browser.'
    OAuth2:
      type: oauth2
      description: For assistants that connect by URL (Claude.ai, ChatGPT, Grok). Authorization code with PKCE (S256 only); register a client with dynamic client registration at https://api.hypamoon.com/oauth/register. Send resource=https://api.hypamoon.com/api/v1/mcp. The user picks the project (test or live) and the scopes on the consent screen. The access token (hm_oat_...) works on every /api/v1 route, not only /mcp; refresh it with the refresh token. The user can revoke a connection in the portal under Koppelingen.
      flows:
        authorizationCode:
          authorizationUrl: https://app.hypamoon.com/oauth/authorize
          tokenUrl: https://api.hypamoon.com/oauth/token
          refreshUrl: https://api.hypamoon.com/oauth/token
          scopes:
            project:read: 'Read the project: its name, whether it is in test mode or live, and what still needs to be done'
            project:write: Fill in the project's company or personal details, manage agents and request secrets for other services
            numbers:read: Read the numbers and their call plans
            calls:read: Read calls, with transcript and summary
            numbers:write: Order numbers and change call plans
            assistant:write: Configure the voice AI assistant
            webhooks:write: Create, test and delete webhooks
            messages:read: Read the text messages and emails the project sent, with their status
            messages:write: Send text messages (SMS) and emails on behalf of the project
            calls:write: Let the assistant call people on behalf of the project
            chat:read: Read the chat conversations with the assistant, with messages and summary
            chat:write: Start chat conversations with the assistant and send customer messages
            sites:read: Read the project's sites, apps and domains
            sites:write: Publish sites and apps on <slug>.hypamoon.app, change and delete them, and manage domains
            data:read: Read the project's collections and their documents, and the business processes (brain)
            data:write: Create, change and delete collections and their documents, and the business processes (brain)
            clients:read: 'As an agency: list your client projects, read their usage and activity, and read inside a client project with the Hypamoon-Project header'
            clients:write: 'As an agency: set up client projects, ask clients for access, invite owners, and build inside a client project with the Hypamoon-Project header'
x-hypamoon-error-docs: https://hypamoon.com/docs/errors/
x-hypamoon-error-types:
- slug: bad_request
  status:
  - 400
  type: https://hypamoon.com/docs/errors/bad_request
- slug: unauthorized
  status:
  - 401
  type: https://hypamoon.com/docs/errors/unauthorized
- slug: payment_required
  status:
  - 402
  type: https://hypamoon.com/docs/errors/payment_required
- slug: forbidden
  status:
  - 403
  type: https://hypamoon.com/docs/errors/forbidden
- slug: not_found
  status:
  - 404
  type: https://hypamoon.com/docs/errors/not_found
- slug: method_not_allowed
  status:
  - 405
  type: https://hypamoon.com/docs/errors/method_not_allowed
- slug: conflict
  status:
  - 409
  type: https://hypamoon.com/docs/errors/conflict
- slug: version_conflict
  status:
  - 409
  - 412
  type: https://hypamoon.com/docs/errors/version_conflict
- slug: confirmation_required
  status:
  - 409
  type: https://hypamoon.com/docs/errors/confirmation_required
- slug: validation_failed
  status:
  - 422
  type: https://hypamoon.com/docs/errors/validation_failed
- slug: rate_limited
  status:
  - 429
  type: https://hypamoon.com/docs/errors/rate_limited
- slug: internal_error
  status:
  - 500
  type: https://hypamoon.com/docs/errors/internal_error
- slug: upstream_error
  status:
  - 502
  type: https://hypamoon.com/docs/errors/upstream_error
- slug: service_unavailable
  status:
  - 503
  type: https://hypamoon.com/docs/errors/service_unavailable
- slug: invalid_json
  status:
  - 400
  type: https://hypamoon.com/docs/errors/invalid_json
- slug: invalid_parameter
  status:
  - 400
  type: https://hypamoon.com/docs/errors/invalid_parameter
- slug: missing_api_key
  status:
  - 401
  type: https://hypamoon.com/docs/errors/missing_api_key
- slug: invalid_api_key
  status:
  - 401
  type: https://hypamoon.com/docs/errors/invalid_api_key
- slug: api_key_revoked
  status:
  - 401
  type: https://hypamoon.com/docs/errors/api_key_revoked
- slug: api_key_expired
  status:
  - 401
  type: https://hypamoon.com/docs/errors/api_key_expired
- slug: project_deleted
  status:
  - 401
  type: https://hypamoon.com/docs/errors/project_deleted
- slug: project_not_enabled
  status:
  - 403
  type: https://hypamoon.com/docs/errors/project_not_enabled
- slug: missing_scope
  status:
  - 403
  type: https://hypamoon.com/docs/errors/missing_scope
- slug: ip_not_allowed
  status:
  - 403
  type: https://hypamoon.com/docs/errors/ip_not_allowed
- slug: invalid_chat_token
  status:
  - 401
  type: https://hypamoon.com/docs/errors/invalid_chat_token
- slug: chat_token_revoked
  status:
  - 401
  - 409
  type: https://hypamoon.com/docs/errors/chat_token_revoked
- slug: origin_not_allowed
  status:
  - 403
  type: https://hypamoon.com/docs/errors/origin_not_allowed
- slug: turnstile_failed
  status:
  - 403
  type: https://hypamoon.com/docs/errors/turnstile_failed
- slug: invalid_conversation_token
  status:
  - 401
  type: https://hypamoon.com/docs/errors/invalid_conversation_token
- slug: public_chat_limit_reached
  status:
  - 429
  type: https://hypamoon.com/docs/errors/public_chat_limit_reached
- slug: chat_unavailable
  status:
  - 503
  type: https://hypamoon.com/docs/errors/chat_unavailable
- slug: vat_number_invalid
  status:
  - 422
  type: https://hypamoon.com/docs/errors/vat_number_invalid
- slug: country_not_supported
  status:
  - 422
  type: https://hypamoon.com/docs/errors/country_not_supported
- slug: key_mode_mismatch
  status:
  - 403
  type: https://hypamoon.com/docs/errors/key_mode_mismatch
- slug: test_key_required
  status:
  - 403
  type: https://hypamoon.com/docs/errors/test_key_required
- slug: test_number_limit_reached
  status:
  - 422
  type: https://hypamoon.com/docs/errors/test_number_limit_reached
- slug: company_details_missing
  status:
  - 422
  type: https://hypamoon.com/docs/errors/company_details_missing
- slug: business_required
  status:
  - 422
  type: https://hypamoon.com/docs/errors/business_required
- slug: account_type_change_blocked
  status:
  - 422
  type: https://hypamoon.com/docs/errors/account_type_change_blocked
- slug: spend_cap_missing
  status:
  - 422
  type: https://hypamoon.com/docs/errors/spend_cap_missing
- slug: payment_mandate_missing
  status:
  - 402
  type: https://hypamoon.com/docs/errors/payment_mandate_missing
- slug: billing_blocked
  status:
  - 402
  type: https://hypamoon.com/docs/errors/billing_blocked
- slug: insufficient_balance
  status:
  - 402
  type: https://hypamoon.com/docs/errors/insufficient_balance
- slug: regulatory_documents_missing
  status:
  - 422
  type: https://hypamoon.com/docs/errors/regulatory_documents_missing
- slug: verification_required
  status:
  - 403
  type: https://hypamoon.com/docs/errors/verification_required
- slug: number_unavailable
  status:
  - 409
  type: https://hypamoon.com/docs/errors/number_unavailable
- slug: number_already_yours
  status:
  - 409
  type: https://hypamoon.com/docs/errors/number_already_yours
- slug: no_numbers_available
  status:
  - 422
  type: https://hypamoon.com/docs/errors/no_numbers_available


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://artifacts.apis.io/hypamoon-com/openapi/hypamoon-com-assistant-api-openapi.yml