Create Project

Create a new project.

application/json

Request Body required

Project request body

name string required

The name of the project.

welcomeQuestion string

Your AI chat bot will greet the user with this question.

systemPrompt string

This is the base prompt what will be passed to the AI model. You can customize the chat bot's behavior by changing this.

isPublic boolean

If true, the project will be accessible to all users. Only mark it as true if you want to embed your chat bot to your website

showResources boolean

If true, the project will show the resources after answering user's question.

Responses

• 200
• 400
• 401
• 403
• 426
• 500

---

successful operation

application/json

Schema

Example (from schema)

---

Schema

id uuid

The unique identifier of the project

name string

The name of the project.

welcomeQuestion string

Your AI chat bot will greet the user with this question.

systemPrompt string

This is the base prompt what will be passed to the AI model. You can customize the chat bot's behavior by changing this.

isPublic boolean

If true, the project will be accessible to all users. Only mark it as true if you want to embed your chat bot to your website

showResources boolean

If true, the project will show the resources after answering user's question.

dataSources object[]
The data sources that you added to your project
Array [
id uuid
The unique identifier of the data source
projectId uuid
Your Magic AI project id
name string
The name of the data source.
status string
Possible values: [pending, processing, ready, failed]
The status of the data source. If the status is ready, it means that the data source is ready to be used to train the AI model. If the status is processing, it means that the data source is still being processed. You can not use the data source until the status is ready.
sourceType string
Possible values: [file, drive, notion, web, text]
Data source type. This is automatically set by the system depending on how did you connect your data source. You can not change it.
summary string
A short summary of the data source. When you first upload your data source, the system will automatically generate a summary for you.
characterCount integer
]

{
  "id": "5f738671-0ccc-4d32-9b7a-ddab669ab799",
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true,
  "dataSources": [
    {
      "id": "5f738671-0ccc-4d32-9b7a-ddab669ab799",
      "projectId": "5f738671-0ccc-4d32-9b7a-ddab669ab799",
      "name": "Magic AI website home page",
      "status": "ready",
      "sourceType": "file",
      "summary": "string",
      "characterCount": 1000
    }
  ]
}

The specified parameter is invalid

application/json

Schema

Example (from schema)

---

Schema

message string required
details string required
code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

Authentication information is missing or invalid

Response Headers

• WWW_Authenticate string

You don't have permission to access this resource

application/json

Schema

Example (from schema)

---

Schema

message string required
details string required
code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

You need to upgrade your account to access this resource

application/json

Schema

Example (from schema)

---

Schema

message string required
details string required
code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

An unexpected error occurred

application/json

Schema

Example (from schema)

---

Schema

message string required
details string required
code string required

unique error code

{
  "message": "Invalid Request",
  "details": "Project already exists",
  "code": "PROJECT_EXISTS"
}

POST /projects

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

https://api.magicai.ai/v1

Username

Password

Body required

{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}

curl / cURL

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

python / requests

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

go / native

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

nodejs / axios

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

ruby / Net::HTTP

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

csharp / RestSharp

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

php / cURL

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

java / OkHttp

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'

powershell / RestMethod

curl -L -X POST 'https://api.magicai.ai/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "Sample Project",
  "welcomeQuestion": "Hi, how can I help you?",
  "systemPrompt": "string",
  "isPublic": false,
  "showResources": true
}'