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

# S3 Bucket API

> This endpoint creates a new AWS S3 Bucket and an API to communicate with it

### Path

<ParamField path="YOUR_BUCKET_NAME" type="string" required>
  The name that you want to use to reference the S3 bucket you are creating. Must only be alpha numeric with only lower case letters and no special characters except hyphens.
</ParamField>

### Response

<ResponseField name="statusCode" type="number">
  Based off of standard HTTP request guidelines
</ResponseField>

<ResponseField name="body" type="object">
  Information concerning your newly created s3 bucket
</ResponseField>

<ResponseExample>
  ```json Success Response theme={null}
  {
    "statusCode": 200,
    "body" {
      ...
      compelete: true,
    }
  }
  ```

  ```json Error Response theme={null}
  {
    "statusCode": 400,
    "body" {
      err: { ... },
      compelete: false
    }
  }
  ```
</ResponseExample>