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

# Blob Object Post

> Esta documentación ofrece una descripción completa del endpoint POST /v1/objects de la API de SquareCloud Blob.

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

<ParamField body="file" type="file" placeholder="myphone.png" required>
  Usa FormData. (multipart/form-data)
</ParamField>

<ParamField query="name" type="string" placeholder="File Name" required>
  Una cadena que representa el nombre del archivo. (sin extensión)<br />Debe cumplir el patrón a-z, A-Z, 0-9 y \_. (de 3 a 32 caracteres)
</ParamField>

<ParamField query="prefix" type="string" placeholder="File Prefix">
  Una cadena que representa el prefijo del archivo.<br />Debe cumplir el patrón a-z, A-Z, 0-9 y \_. (de 3 a 32 caracteres)
</ParamField>

<ParamField query="expire" type="number" placeholder="Expiration (days)">
  Un número que indica el periodo de expiración del archivo, en un rango de 1 a 365 días.
</ParamField>

<ParamField query="security_hash" type="boolean" placeholder="Security Hash">
  Establece en true si se requiere un hash de seguridad.
</ParamField>

<ParamField query="auto_download" type="boolean" placeholder="Auto Download">
  Establece en true si el archivo debe configurarse para descarga automática.
</ParamField>

### Límites de tasa y concurrencia

<Note>
  La subida requiere un plan de pago.

  * Los planes **Hobby** y **Standard** están limitados a **1 subida por segundo**.
  * Los planes **Pro** y **Enterprise** **no** están sujetos al límite por segundo — en su lugar pueden ejecutar hasta **4 subidas al mismo tiempo**.

  En todos los planes de pago, una cuenta puede tener como máximo **4 subidas en curso simultáneamente**. Iniciar otra subida mientras 4 siguen en ejecución devuelve `TOO_MANY_CONCURRENT_UPLOADS` (429).
</Note>

<Info>
  Por seguridad, los archivos `.html` y `.svg` siempre se entregan como descargas (servidos como `application/octet-stream`) en lugar de renderizarse en línea.
</Info>

### Respuesta

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

<ResponseField name="response" type="object">
  <Expandable title="Alternar objeto">
    <ResponseField name="id" type="string">
      El ID del archivo subido.
    </ResponseField>

    <ResponseField name="name" type="string">
      El nombre del archivo subido.
    </ResponseField>

    <ResponseField name="prefix" type="string">
      El prefijo bajo el cual se almacenó el archivo (reflejado desde la query `prefix`; se omite cuando no se envió ninguno).
    </ResponseField>

    <ResponseField name="size" type="number">
      El tamaño del archivo subido, en bytes.
    </ResponseField>

    <ResponseField name="url" type="string">
      La URL del archivo subido. (Archivo distribuido en la CDN de Square Cloud)
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://blob.squarecloud.app/v1/objects?name=myfile&prefix=images&expire=30' \
    --header 'Authorization: YOUR_API_KEY' \
    --form 'file=@./myphone.png'
  ```

  ```javascript JavaScript theme={null}
  import fs from 'node:fs';

  const form = new FormData();
  form.append('file', new Blob([fs.readFileSync('./myphone.png')]), 'myphone.png');

  const params = new URLSearchParams({
    name: 'myfile',
    prefix: 'images',
    expire: '30',
  });

  const response = await fetch(`https://blob.squarecloud.app/v1/objects?${params}`, {
    method: 'POST',
    headers: { Authorization: 'YOUR_API_KEY' },
    body: form,
  });
  ```

  ```python Python theme={null}
  import requests

  with open('myphone.png', 'rb') as f:
      response = requests.post(
          'https://blob.squarecloud.app/v1/objects',
          headers={'Authorization': 'YOUR_API_KEY'},
          params={'name': 'myfile', 'prefix': 'images', 'expire': 30},
          files={'file': ('myphone.png', f, 'image/png')},
      )
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": {
          "id": "3155597145698959364/images/test_lxch4k7y-07ee.png",
          "name": "test",
          "prefix": "images",
          "size": 416230,
          "url": "https://public-blob.squarecloud.dev/3155597145698959364/images/test_lxch4k7y-07ee.png"
      }
  }
  ```
</ResponseExample>

### Solución de problemas

<Tabs>
  <Tab title="Código de estado 400">
    ### Relacionado con el objeto

    <CodeGroup>
      ```json NAME theme={null}
      // The provided object name is invalid.
      // Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
      {
          "status": "error",
          "code": "INVALID_OBJECT_NAME"
      }
      ```

      ```json PREFIX theme={null}
      // The provided object prefix is invalid.
      // Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
      {
          "status": "error",
          "code": "INVALID_OBJECT_PREFIX"
      }
      ```

      ```json EXPIRE theme={null}
      // The provided expiration value for the object is invalid.
      // Must be a number ranging from 1 to 365. (value in days).
      {
          "status": "error",
          "code": "INVALID_OBJECT_EXPIRE"
      }
      ```

      ```json SECURITY_HASH theme={null}
      // The provided security hash boolean is invalid.
      // Just set to true or false. 😅
      {
          "status": "error",
          "code": "INVALID_OBJECT_SECURITY_HASH"
      }
      ```

      ```json AUTO_DOWNLOAD theme={null}
      // The provided auto-download boolean is invalid.
      // Just set to true or false. 😅
      {
          "status": "error",
          "code": "INVALID_STORAGE_AUTO_DOWNLOAD"
      }
      ```
    </CodeGroup>

    ### Relacionado con el archivo

    <Info>El tamaño máximo actual de archivo es 100MB. En el futuro, planeamos aumentarlo a 10GB. Por ahora, el límite es 100MB debido a restricciones técnicas y de balanceo de carga.</Info>

    <CodeGroup>
      ```json INVALID_FILE theme={null}
      // The provided file is invalid.
      {
          "status": "error",
          "code": "INVALID_FILE"
      }
      ```

      ```json FILETYPE theme={null}
      // The provided file type is invalid.
      {
          "status": "error",
          "code": "INVALID_FILETYPE"
      }
      ```

      ```json FILE_TOO_SMALL theme={null}
      // The file size is too small (< 1kb).
      {
          "status": "error",
          "code": "FILE_TOO_SMALL"
      }
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Código de estado 401">
    ### No autorizado

    <CodeGroup>
      ```json ACCESS_DENIED theme={null}
      // The API key is missing or invalid. Set a valid key in the Authorization header.
      // Also returned when the account is on the free plan — uploading requires a paid plan.
      {
          "status": "error",
          "code": "ACCESS_DENIED"
      }
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Código de estado 403">
    ### Cuota de almacenamiento superada

    <CodeGroup>
      ```json STORAGE_QUOTA_EXCEEDED theme={null}
      // You have exceeded your storage quota. Delete some files or upgrade your plan.
      {
          "status": "error",
          "code": "STORAGE_QUOTA_EXCEEDED"
      }
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Código de estado 409">
    ### Tipo de contenido inválido

    <CodeGroup>
      ```json INVALID_CONTENT_TYPE theme={null}
      // This route only accepts multipart/form-data requests.
      {
          "status": "error",
          "code": "INVALID_CONTENT_TYPE"
      }
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Código de estado 413">
    ### Carga útil demasiado grande

    <Info>El tamaño máximo actual de archivo es 100MB.</Info>

    <CodeGroup>
      ```json PAYLOAD_TOO_LARGE theme={null}
      // The uploaded file exceeds the maximum allowed size of 100 MB.
      {
          "status": "error",
          "code": "PAYLOAD_TOO_LARGE"
      }
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Código de estado 429">
    ### Límite de tasa alcanzado

    <CodeGroup>
      ```json RATELIMIT theme={null}
      // Per-second upload limit reached (Hobby/Standard: max 1 upload per second).
      {
          "status": "error",
          "code": "RATELIMIT"
      }
      ```

      ```json TOO_MANY_CONCURRENT_UPLOADS theme={null}
      // Too many simultaneous uploads (max 4 in progress at a time per account).
      {
          "status": "error",
          "code": "TOO_MANY_CONCURRENT_UPLOADS"
      }
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Código de estado 500">
    ### Fallo en la subida

    <CodeGroup>
      ```json UPLOAD_FAILED theme={null}
      // Failed to upload object to storage. Please try again later.
      {
          "status": "error",
          "code": "UPLOAD_FAILED"
      }
      ```
    </CodeGroup>
  </Tab>
</Tabs>
