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

# Leer archivo

> Lee un archivo de tu aplicación.

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  La clave de API de tu cuenta. Puedes encontrarla en la [configuración de tu cuenta](https://squarecloud.app/es/account/security).
</ParamField>

### Parámetros

<ParamField path="app_id" type="string" placeholder="Application ID" required>
  El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.
</ParamField>

<ParamField query="path" type="string" placeholder="Example: src/index.js" required>
  La ruta del archivo que quieres leer. Es relativa a la raíz de tu aplicación.
</ParamField>

### Respuesta

<ResponseField name="status" type="string">
  Indica si la llamada fue exitosa. `success` si fue exitosa, `error` si no.
</ResponseField>

<ResponseField name="response" type="object">
  El contenido del archivo.

  <Expandable title="Alternar objeto">
    <ResponseField name="type" type="string">
      El tipo de los datos. Es "Buffer" para datos binarios.
    </ResponseField>

    <ResponseField name="data" type="array">
      Los datos del archivo representados como un array de números. Estos números representan los bytes del archivo.
    </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>
