> ## Documentation Index
> Fetch the complete documentation index at: https://ajuda.memberkit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Prepara o envio de um arquivo

> Prepara o envio direto de um arquivo.

Arquivos são enviados direto para o armazenamento, em três passos:

1. Chame este endpoint com o nome, o tamanho, o tipo, o `checksum` (o MD5 do arquivo, em base64) e o `purpose`. O tamanho e o tipo são conferidos aqui, antes do envio.
2. Envie o arquivo com `PUT` para a URL de `direct_upload`, com os cabeçalhos que vêm junto.
3. Use o `signed_id` no campo do recurso.

| `purpose` | Uso | Tipos aceitos |
| :- | :- | :- |
| `forum_post_file` | Anexo de uma publicação da comunidade, no campo `files`. | PDF, Word, Excel, PowerPoint, OpenDocument, RTF, texto, JPEG, PNG, BMP e TIFF. |
| `forum_post_image` | Imagem no texto de uma publicação. O endereço permanente vem em `url`, para usar no `src` da imagem. | JPEG, PNG, GIF e WebP. |
| `profile_image` | Foto do perfil, no campo `profile_image`. | JPEG, PNG, GIF, WebP, AVIF, HEIC, TIFF e BMP. |

O limite é de 10 MB por arquivo. Um tipo fora da lista ou um arquivo grande demais responde `validation_failed` aqui, antes do envio.


## OpenAPI

````yaml headless/openapi.yml POST /api/headless/v1/uploads
openapi: 3.1.0
info:
  title: MemberKit Headless
  version: 1.0.0
servers: []
security:
  - bearer: []
    headlessKey: []
tags:
  - name: academy
  - name: auth
  - name: onboarding
  - name: courses
  - name: categories
  - name: banners
  - name: bookmarks
  - name: kv
  - name: comments
  - name: quizzes
  - name: search
  - name: ranking
  - name: profile
  - name: certificates
  - name: contact_messages
  - name: notifications
  - name: uploads
  - name: assistant
  - name: community
  - name: lessons
paths:
  /api/headless/v1/uploads:
    post:
      tags:
        - uploads
      summary: Prepara o envio de um arquivo
      description: Prepara o envio direto de um arquivo.
      operationId: createUpload
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - purpose
                - filename
                - byte_size
                - checksum
                - content_type
              properties:
                purpose:
                  type: string
                  enum:
                    - forum_post_file
                    - forum_post_image
                    - profile_image
                filename:
                  type: string
                byte_size:
                  type: integer
                checksum:
                  type: string
                content_type:
                  type: string
      responses:
        '201':
          description: Upload preparado
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
        '400':
          $ref: '#/components/responses/MalformedRequest'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '409':
          $ref: '#/components/responses/RequestInProgress'
        '422':
          $ref: '#/components/responses/InvalidParameters'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: Chave única do envio, para que uma repetição não seja duplicada.
  headers:
    IdempotentReplayed:
      description: >-
        Presente quando a resposta repete um envio anterior. Os links assinados
        dessa resposta, como download_url, podem já ter expirado; busque o
        recurso de novo para renová-los.
      schema:
        type: string
  schemas:
    Upload:
      type: object
      required:
        - signed_id
        - purpose
        - filename
        - byte_size
        - content_type
        - url
        - direct_upload
      properties:
        signed_id:
          type: string
        purpose:
          type: string
        filename:
          type: string
        byte_size:
          type: integer
        content_type:
          type: string
        url:
          type:
            - string
            - 'null'
          description: URL permanente da imagem, presente com purpose forum_post_image.
        direct_upload:
          type: object
          required:
            - url
            - headers
          properties:
            url:
              type: string
            headers:
              type: object
              additionalProperties:
                type: string
    Error:
      type: object
      description: Formato de todos os erros.
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: Código do erro.
          enum:
            - subscription_suspended
            - onboarding_required
            - course_onboarding_required
            - access_expired
            - content_locked
            - comments_disabled
            - unprocessable_certificate
            - unauthenticated
            - invalid_credentials
            - invalid_token
            - invalid_headless_key
            - session_replaced
            - session_revoked
            - account_locked
            - forbidden
            - not_found
            - missing_parameter
            - malformed_request
            - validation_failed
            - invalid_signed_id
            - rate_limited
            - idempotency_key_reused
            - request_in_progress
            - assistant_unavailable
            - quiz_required
        message:
          type: string
        request_id:
          type: string
        errors:
          type: object
          description: Erros de cada campo, presentes com o código validation_failed.
          additionalProperties:
            type: array
            items:
              type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                  description: Motivo do erro, como blank, taken, too_short ou invalid.
                message:
                  type: string
                  description: Mensagem pronta para exibir, no idioma da área de membros.
  responses:
    MalformedRequest:
      description: Requisição malformada (code malformed_request).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthenticated:
      description: >-
        Membro não autenticado (code unauthenticated, invalid_token,
        session_replaced, session_revoked ou invalid_headless_key).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    SubscriptionSuspended:
      description: Assinatura da área de membros suspensa (code subscription_suspended).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RequestInProgress:
      description: Requisição em andamento (code request_in_progress).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InvalidParameters:
      description: >-
        Parâmetros inválidos (code validation_failed, invalid_signed_id,
        missing_parameter ou idempotency_key_reused).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Limite de requisições atingido (code rate_limited).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
    headlessKey:
      type: apiKey
      in: header
      name: X-Memberkit-Headless-Key
      description: >-
        Chave headless da área de membros, em Configurações. É pública e vai em
        todas as requisições, inclusive nas que levam o token do membro.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.