Skip to main content
POST
/
api
/
v1
/
projects
curl --request POST \
  --url http://localhost:3000/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "AI Chatbot",
    "description": "Customer service chatbot",
    "icon": "🤖",
    "color": "#3B82F6"
  }'

{
  "success": true,
  "message": "Project created",
  "project": {
    "id": "proj_123abc",
    "name": "AI Chatbot",
    "description": "Customer service chatbot",
    "icon": "🤖",
    "color": "#3B82F6",
    "createdAt": "2024-01-17T10:30:00Z",
    "updatedAt": "2024-01-17T10:30:00Z"
  }
}

​
Body Parameters

​
name
string
required
Project name
​
description
string
Project description
​
icon
string
Project icon (emoji or icon identifier)
​
color
string
Project color (hex code, e.g., #3B82F6)

​
Response

​
success
boolean
Indicates if the project was created successfully
​
message
string
Success or error message
​
project
object
The newly created project object
curl --request POST \
  --url http://localhost:3000/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "AI Chatbot",
    "description": "Customer service chatbot",
    "icon": "🤖",
    "color": "#3B82F6"
  }'

{
  "success": true,
  "message": "Project created",
  "project": {
    "id": "proj_123abc",
    "name": "AI Chatbot",
    "description": "Customer service chatbot",
    "icon": "🤖",
    "color": "#3B82F6",
    "createdAt": "2024-01-17T10:30:00Z",
    "updatedAt": "2024-01-17T10:30:00Z"
  }
}

​
Notes

  • Only the name field is required
  • Icons can be emojis or icon identifiers from your icon library
  • Colors should be in hex format (e.g., #3B82F6)
  • The project is automatically associated with the authenticated user