> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Disponibilidade de endereço

> Se um endereço do classroom pode ser escolhido agora. É o que o onboarding consulta enquanto a pessoa digita; a criação confere de novo.



## OpenAPI

````yaml GET /v1/clubs/slug-availability
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
paths:
  /v1/clubs/slug-availability:
    get:
      tags:
        - clubs
      summary: Se um endereço do classroom pode ser escolhido
      description: |
        O que o onboarding consulta enquanto a pessoa digita o endereço, para
        dizer "livre" ou "em uso" antes do envio. É só uma resposta de agora: o
        `POST /v1/clubs` confere de novo, e quem perder a corrida recebe 409.

        Exige sessão, mas não é escopada — quem cria o club ainda não tem um.
        Não entrega nada que a vitrine (`by-slug`) não entregue: o endereço ou
        atende ou não atende.

        Nome reservado pelo produto responde `taken`, igual a um endereço de
        outro club: para quem escolhe, os dois são "já está em uso", e separar
        entregaria a lista.
      operationId: getSlugAvailability
      parameters:
        - name: slug
          in: query
          required: true
          description: O endereço que a pessoa quer, como digitou.
          schema:
            type: string
            maxLength: 63
      responses:
        '200':
          description: A situação do endereço agora
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlugAvailabilityResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  schemas:
    SlugAvailabilityResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/SlugAvailability'
    SlugAvailability:
      type: object
      required:
        - slug
        - available
      properties:
        slug:
          type: string
          description: >-
            O endereço conferido, já normalizado (sem espaço nas pontas,
            minúsculo).
        available:
          type: boolean
        reason:
          type: string
          enum:
            - invalid
            - taken
          description: |
            Presente só quando `available` é falso. `invalid` é formato que o
            DNS não aceita; `taken` é endereço de outro club ou reservado.
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````

## Related topics

- [Club de um endereço](/api-reference/clubs/by-slug.md)
- [Limites de uso](/essentials/rate-limits.md)
- [Nome e endereço do club](/api-reference/clubs/update.md)
- [Webhooks de saída](/essentials/webhooks.md)
- [Biblioteca de mídia](/essentials/media.md)