Skip to main content
POST
/
projects
Create Project
curl --request POST \
  --url https://api.us.vartiq.com/projects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Body Parameters

name
string
required
Name of the project
description
string
Optional description of the project

Response

success
boolean
Indicates if the request was successful
message
string
A message describing the result of the operation
data
object
The created project object

Response Example

{
  "success": true,
  "message": "Project created successfully",
  "data": {
    "id": "proj_01JTD1G189Y47YNPWNJDYRXW39",
    "name": "New Project",
    "createdAt": "2025-05-04T06:59:47.599Z",
    "updatedAt": "2025-05-04T06:59:47.599Z"
  }
}