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

# Ler arquivo

> Ler um arquivo da sua aplicação.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

### Parâmetros

<ParamField path="app_id" type="string" placeholder="ID da Aplicação" required>
  O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.
</ParamField>

<ParamField query="path" type="string" placeholder="Exemplo: src/index.js" required>
  O caminho para o arquivo que você deseja ler. Este caminho é relativo à raiz da sua aplicação.
</ParamField>

### Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida. `success` se bem-sucedida, `error` se não.
</ResponseField>

<ResponseField name="response" type="object">
  O conteúdo do arquivo.

  <Expandable title="Alternar objeto">
    <ResponseField name="type" type="string">
      O tipo dos dados. É "Buffer" para dados binários.
    </ResponseField>

    <ResponseField name="data" type="array">
      Os dados do arquivo representados como um array de números. Esses números representam os bytes do arquivo.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": {
          "type": "Buffer",
          "data": [
              112,
              111,
              120,
              97,
              44,
              32,
              116,
              97,
              32,
              113,
              117,
              101,
              114,
              101,
              110,
              100,
              111,
              32,
              99,
              111,
              112,
              105,
              97,
              114,
              32,
              97,
              116,
              195,
              169,
              32,
              111,
              32,
              98,
              117,
              102,
              102,
              101,
              114,
              63
          ]
      }
  }
  ```
</ResponseExample>