---
title: "get"
method: GET
path: "/v1/bucket/{bucketId}"
tags: ["Buckets"]
---

# get

`GET /v1/bucket/{bucketId}`

## Request

- Base URL: `https://api.groundx.ai/api`
- URL: `https://api.groundx.ai/api/v1/bucket/{bucketId}`
- Auth: API key in header `X-API-Key`

Look up a specific bucket by its bucketId.

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Path parameters

- `bucketId` integer, required

## Response `200`

Look up success

- BucketResponse
  - `bucket` BucketDetail, required
    - `bucketId` integer, required
    - `created` string, date-time: The data time when the bucket was created, in RFC3339 format
    - `fileCount` integer: The number of files contained in the content bucket
    - `fileSize` string: The total file size of files contained in the content bucket
    - `name` string
    - `updated` string, date-time: The data time when the bucket was last updated, in RFC3339 format

## Other responses

- `400`: Invalid bucket ID
- `401`: Unauthorized to access bucket with given ID

## Changes

- **2023-10-13** `43657b55255e`: 2 info
  - added the optional property `bucket/created` to the response with the `200` status
  - added the optional property `bucket/updated` to the response with the `200` status
- **2023-10-05** `5ee59ea914aa`: 2 info
  - api tag `Buckets` added
  - api tag `Bucket` removed
- **2023-10-05** `006f5c1a8d40`: 1 info
  - the response property `bucket/bucketId` became required for the status `200`
- **2023-10-05** `9f04a0095408`: 1 info
  - the response property `bucket` became required for the status `200`
- **2023-10-04** `7d474e21a108`: 2 info
  - api operation id `getBucketById` removed and replaced with `Bucket_get`
  - api tag `Bucket` added

[Operation history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/bucket/:bucketId/get.md)

---

[API](https://skmtc.dev/groundxai/apis/groundx-apis.md) - [All operations](https://skmtc.dev/groundxai/apis/groundx-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/groundxai/apis/groundx-apis/revisions/1c1a5c17f52f?raw)