---
title: "create"
method: POST
path: "/v1/project"
tags: ["Projects"]
---

# create

`POST /v1/project`

create a new project, a project being a collection of buckets which can be searched.

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.

## Request body

- ProjectCreateRequest
  - `name` string, required — The name of the project being created.
  - `bucketName` string — Specify bucketName to automatically create a bucket, by the name specified, and add it to the created project.

## Response `200`

Project successfully created

- ProjectResponse
  - `project` ProjectDetail, required
    - `buckets` BucketDetail[] — The content buckets associated with the project
      - `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
    - `created` string, date-time — The data time when the project was created, in RFC3339 format
    - `fileCount` integer — The number of files contained in the content buckets associated with the project
    - `fileSize` string — The total file size of files contained in the content buckets associated with the project
    - `projectId` integer, required
    - `name` string
    - `updated` string, date-time — The data time when the project was last updated, in RFC3339 format

## Other responses

- `400` — Invalid body parameter

## Changes

- **2023-11-29** `3bb565058636` — 1 info
  - endpoint added
- **2023-10-05** `5ee59ea914aa` — 1 breaking
  - api removed without deprecation
- **2023-10-05** `05194fdd107e` — 1 breaking, 2 info
  - the `project/projectId` response's property type changed from `string` to `integer` for status `200`
  - the response property `project` became required for the status `200`
  - the response property `project/projectId` became required for the status `200`
- **2023-10-05** `006f5c1a8d40` — 1 info
  - the response property `project/buckets/items/bucketId` became required for the status `200`
- **2023-10-05** `d110e0768c77` — 1 breaking
  - the request property `project` became required

[Full history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/project/post.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/d177cd9fa116?raw)