> ## 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.

# Criar chave de API

> Uma chave para o agente que não faz o fluxo OAuth.

A chave vai no cabeçalho `Authorization: Bearer weve_sk_…` do [servidor MCP](/essentials/mcp#chave-de-api).


## OpenAPI

````yaml POST /v1/clubs/{clubId}/api-keys
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
  - name: certificates
  - name: terms
  - name: mcp
paths:
  /v1/clubs/{clubId}/api-keys:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    post:
      tags:
        - mcp
      summary: Cria uma chave de API
      description: |
        Para o agente que não faz o fluxo OAuth — uma automação no n8n, um
        script, um cliente MCP configurado à mão. A chave age em nome de quem a
        criou, neste club, com o papel que a pessoa tem aqui, e vai no cabeçalho
        `Authorization: Bearer weve_sk_…` do `/mcp`.

        A chave aparece **uma única vez**, nesta resposta. `expires_in_days`
        ausente é chave sem prazo — revogável a qualquer momento. Até 20 chaves
        vivas por club.

        Só cria quem o ajuste `agent_access` do club deixa usar agentes (por
        padrão, quem administra).

        Erros: `invalid_name` e `invalid_scopes` (422); `api_key_limit` (409);
        `agent_access_disabled` e `agent_access_admins_only` (403).
      operationId: createApiKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyCreate'
      responses:
        '201':
          description: Criada. A chave só aparece aqui.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeySecretResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
  schemas:
    ApiKeyCreate:
      type: object
      required:
        - name
        - scopes
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
          description: Para reconhecer a chave depois — "n8n do suporte".
        scopes:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/AccessScope'
        expires_in_days:
          type: integer
          minimum: 1
          maximum: 730
          nullable: true
    ApiKeySecretResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ApiKeySecret'
    AccessScope:
      type: string
      enum:
        - read
        - write
      description: |
        `read` consulta; `write` cria, altera e envia. Nenhum dos dois amplia o
        papel da pessoa no club: quem não administra continua sem administrar.
    ApiKeySecret:
      type: object
      required:
        - grant
        - key
      properties:
        grant:
          $ref: '#/components/schemas/AccessGrant'
        key:
          type: string
          description: '`weve_sk_` seguido do segredo. Guarde agora: não é mostrada de novo.'
    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
    AccessGrant:
      type: object
      required:
        - id
        - kind
        - name
        - scopes
        - token_hint
        - user_id
        - user_name
        - created_at
      properties:
        id:
          type: string
          format: uuid
        kind:
          $ref: '#/components/schemas/AccessGrantKind'
        name:
          type: string
          description: O nome da chave, ou o do cliente OAuth.
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/AccessScope'
        token_hint:
          type: string
          description: Os últimos caracteres do segredo.
        client_uri:
          type: string
          nullable: true
        logo_uri:
          type: string
          nullable: true
        user_id:
          type: string
          format: uuid
        user_name:
          type: string
          description: Em nome de quem o agente age.
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: |
            Quando para de valer sem uso: o prazo da chave, ou o do refresh da
            conexão (que se renova a cada uso). Nulo é chave sem prazo.
        last_used_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
    AccessGrantKind:
      type: string
      enum:
        - oauth
        - api_key
      description: >-
        `oauth`: um agente conectado pelo fluxo OAuth. `api_key`: uma chave
        criada à mão.
  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'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Conflict:
      description: >-
        Conflito com o estado atual. O `code` diz qual; a descrição da operação
        lista os possíveis.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: Campos obrigatórios ausentes ou inválidos
      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

- [Conectar agentes (MCP)](/essentials/mcp.md)
- [Criar conta](/api-reference/account/sign-up.md)
- [Criar tag](/api-reference/students/tags-create.md)
- [Criar agente](/api-reference/agents/create.md)
- [Criar entrega](/api-reference/catalog/deliveries-create.md)