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

# Ler um arquivo

> Leia o texto de um arquivo do projeto.

Devolve o texto de um arquivo (UTF-8, até 1 MB). Arquivo binário ou maior: [baixe](/api-reference/files/download-link).

Permissão da chave: `files:read` ([Chaves de API](/api-keys)).

## Erros comuns

| Código | HTTP | O que fazer |
| - | - | - |
| [`insufficient_scope`](/errors#param-insufficient-scope) | 403 | A chave não tem a permissão da rota (`requiredScope` diz qual): marque em Chaves de API › Editar permissões. |
| [`invalid_path`](/errors#param-invalid-path) | 400 | O caminho precisa ficar dentro do projeto, sem `..`, `/` no começo nem `\`. |
| [`files_not_allowed`](/errors#param-files-not-allowed) | 403 | O Free não tem os arquivos do projeto: mude para um plano pago. |
| [`file_not_found`](/errors#param-file-not-found) | 404 | Liste a pasta de novo e confira o caminho. |
| [`project_busy`](/errors#param-project-busy) | 409 | Espere o envio ou a instalação em curso terminar. |
| [`file_too_large`](/errors#param-file-too-large) | 413 | Até 1 MB para ler ou escrever como texto; até 500 MB pelo envio em partes. |
| [`binary_file`](/errors#param-binary-file) | 422 | Não é texto: baixe pelo link de download. |
| [`special_file`](/errors#param-special-file) | 422 | É um atalho ou arquivo especial: troque pelo arquivo de verdade. |

Todos os códigos, com o formato do erro, em [Códigos de erro](/errors).


## OpenAPI

````yaml GET /projects/{id}/files/content
openapi: 3.1.0
info:
  title: API da Cube Hosting
  version: 1.0.0
  description: >-
    Hospede bots de Discord, sites e APIs em Node.js e Python: envie o .zip,
    inicie, pare, reinicie, leia logs e métricas, veja a análise das visitas dos
    sites, cuide das variáveis de ambiente, faça e baixe backups, volte para uma
    versão anterior, crie bancos de dados (PostgreSQL, MySQL, MongoDB e Redis),
    guarde arquivos privados no Blob, use um domínio seu nos sites e veja o uso
    do plano. Para agentes de IA, o servidor MCP da conta (`POST
    https://app.cubehosting.com.br/api/mcp`, JSON-RPC, com a mesma chave) está
    em https://docs.cubehosting.com.br/account-mcp.
  contact:
    name: Cube Hosting
    url: https://discord.gg/pv6D9tUsDV
servers:
  - url: https://app.cubehosting.com.br/api
security:
  - bearerAuth: []
tags:
  - name: Projetos
  - name: Controle
  - name: Logs e métricas
  - name: Análise
  - name: Variáveis de ambiente
  - name: Arquivos
  - name: Backups
  - name: Versões dos envios
  - name: Bancos de dados
  - name: Blob
  - name: Domínios
  - name: Templates
  - name: Avisos
  - name: Conta
paths:
  /projects/{id}/files/content:
    get:
      tags:
        - Arquivos
      summary: Ler um arquivo
      description: >-
        O texto de um arquivo (UTF-8, até 1 MB). Para outro tipo ou tamanho,
        [baixe](/api-reference/files/download-link). Só nos planos pagos (no
        Free, `403 files_not_allowed`). Tudo acontece na caixa do seu projeto, e
        cada ação entra na Atividade com o nome da chave.


        **Permissão da chave:** `files:read` (Arquivos · ler). Veja [Chaves de
        API](/api-keys).
      operationId: readFile
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - name: path
          in: query
          required: true
          description: >-
            Caminho relativo à raiz do projeto, sem `/` no começo (ex.:
            `src/index.js`).
          schema:
            type: string
            maxLength: 4096
      responses:
        '200':
          description: O arquivo.
          content:
            application/json:
              schema:
                type: object
                required:
                  - path
                  - content
                  - sizeBytes
                  - modifiedAt
                properties:
                  path:
                    type: string
                  content:
                    type: string
                  sizeBytes:
                    type: integer
                  modifiedAt:
                    type: string
                    format: date-time
                  isProtected:
                    type: boolean
              example:
                path: src/index.js
                content: |
                  console.log('oi');
                sizeBytes: 19
                modifiedAt: '2026-09-30T18:01:00.000Z'
                isProtected: false
        '400':
          description: >-
            O caminho sai da pasta do projeto ou o pedido veio fora do formato.
            Nada chegou aos arquivos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_path:
                  summary: invalid_path
                  value:
                    status: error
                    code: invalid_path
                    message: >-
                      O caminho precisa ficar dentro da pasta do projeto, sem
                      "..", e o nome não pode ter "\".
        '401':
          description: Chave ausente, inválida ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_api_key:
                  summary: invalid_api_key
                  value:
                    status: error
                    code: invalid_api_key
                    message: >-
                      Chave de API inválida ou revogada. Confira o cabeçalho
                      "Authorization: Bearer <chave>" ou crie outra em Chaves de
                      API no painel.
        '403':
          description: >-
            A chave não tem a permissão, o plano é o Free ou o caminho é só
            leitura.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                insufficient_scope:
                  summary: insufficient_scope
                  value:
                    status: error
                    code: insufficient_scope
                    message: >-
                      Esta chave não tem a permissão Arquivos · ler. Marque a
                      permissão na chave em Chaves de API no painel, ou use
                      outra chave.
                    requiredScope: files:read
                files_not_allowed:
                  summary: files_not_allowed
                  value:
                    status: error
                    code: files_not_allowed
                    message: >-
                      O plano Free não inclui o explorador de arquivos. Mude
                      para um plano pago para ver e editar os arquivos pelo
                      painel.
        '404':
          description: O projeto não existe ou não é da sua conta, ou o arquivo não existe.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  summary: not_found
                  value:
                    status: error
                    code: not_found
                    message: Projeto não encontrado.
                file_not_found:
                  summary: file_not_found
                  value:
                    status: error
                    code: file_not_found
                    message: Arquivo ou pasta não encontrado. Atualize a lista.
        '409':
          description: O projeto ainda está sendo enviado, ou o arquivo já existe.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                project_busy:
                  summary: project_busy
                  value:
                    status: error
                    code: project_busy
                    message: >-
                      O projeto ainda está sendo enviado. Espere terminar para
                      abrir os arquivos.
        '413':
          description: O arquivo ou a seleção passa do limite.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                file_too_large:
                  summary: file_too_large
                  value:
                    status: error
                    code: file_too_large
                    message: >-
                      O arquivo passa do limite: até 1 MB para abrir no editor e
                      até 500 MB para enviar.
        '422':
          description: O arquivo não é texto, é um atalho ou a seleção ficou vazia.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                binary_file:
                  summary: binary_file
                  value:
                    status: error
                    code: binary_file
                    message: >-
                      Este arquivo não é texto. Baixe para abrir no seu
                      computador.
                special_file:
                  summary: special_file
                  value:
                    status: error
                    code: special_file
                    message: >-
                      Atalhos (links) e arquivos especiais não abrem pelo
                      painel. Apague o atalho ou troque pelo arquivo de verdade.
        '429':
          description: Limite de pedidos. Traz o cabeçalho `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limit_exceeded:
                  summary: rate_limit_exceeded
                  value:
                    status: error
                    code: rate_limit_exceeded
                    message: >-
                      A sua conta passou do limite da API do plano Free: 10
                      pedidos por minuto. Espere 42 s e tente de novo.
                too_many_attempts:
                  summary: too_many_attempts
                  value:
                    status: error
                    code: too_many_attempts
                    message: Muitas tentativas. Tente de novo em 15 minutos.
        '503':
          description: O servidor dos projetos não respondeu a tempo. Nada foi alterado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server_unavailable:
                  summary: server_unavailable
                  value:
                    status: error
                    code: server_unavailable
                    message: >-
                      O servidor dos projetos não respondeu. Tente de novo em
                      instantes.
      security:
        - bearerAuth:
            - files:read
      x-codeSamples:
        - lang: bash
          label: curl
          source: >-
            curl -X GET
            "https://app.cubehosting.com.br/api/projects/$PROJECT_ID/files/content?path=src/index.js"
            \
              -H "Authorization: Bearer $CUBE_API_KEY"
        - lang: javascript
          label: Node.js
          source: >-
            const API = 'https://app.cubehosting.com.br/api';

            const headers = { Authorization: `Bearer
            ${process.env.CUBE_API_KEY}` };


            const res = await
            fetch(`${API}/projects/${process.env.PROJECT_ID}/files/content` +
            '?path=src/index.js', {
              method: 'GET',
              headers,
            });

            console.log((await res.json()).content);
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            API = "https://app.cubehosting.com.br/api"
            headers = {"Authorization": f"Bearer {os.environ['CUBE_API_KEY']}"}

            r = requests.get(
                f"{API}/projects/{os.environ['PROJECT_ID']}/files/content",
                headers=headers,
                params={"path": "src/index.js"},
                timeout=60,
            )
            r.raise_for_status()
            print(r.json()["content"])
components:
  parameters:
    ProjectId:
      name: id
      in: path
      required: true
      description: >-
        O ID do projeto (26 caracteres). Aparece no painel, no topo do projeto,
        e em `GET /projects`.
      schema:
        type: string
        pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
        example: 01J8Z3W6N0Q4Y7V2K5T9D1H3XA
  schemas:
    Error:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: string
          const: error
        code:
          type: string
          description: Código fixo em inglês. Veja [Códigos de erro](/errors).
        message:
          type: string
          description: Texto em português para mostrar a uma pessoa.
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API da Cube (`cube_…`), criada no painel em **Chaves de API**.
        Mande como `Authorization: Bearer cube_…`. Cada rota pede uma permissão
        da chave (o escopo no `security` da rota, como `files:write`); sem ela,
        `403 insufficient_scope` com o `requiredScope`. Veja [Chaves de
        API](/api-keys).

````