Skip to main content

Create Project

Creating a project in Raccoon AI is a straightforward process that allows you to organize your machine learning endeavors. With just a few steps, you can set up a dedicated workspace for your work. By creating a project, you gain the ability to store and manage your trained models and weights securely. It enables easy access to your models and facilitates collaboration with other users. Raccoon AI's project feature helps you maintain organization and control over your machine learning projects from start to finish.

Method: POST Authorization: JWT
https://engine.raccoon-ai.io/api/v1/projects/new

Authorization

TypeKeyValue
JWTAuthorizationBearer ##########

Request Body

KeyData TypeRequiredDescription
namestringtrueName of the project
descriptionstringtrueProject description
algo_typestringtrueAlgorithm type expecting to build the model (For user referance only)
algo_selectedstringtrueAlgorithm that use to build the model (For user referance only)

Types

{
"name": <string>,
"description": <string>,
"algo_type": <string>,
"algo_selected": <string>
}

Sample

{
"name": "My Project",
"description": "This is my project",
"algo_type": "Regression",
"algo_selected": "Multiple Linear Regression"
}

Reponse Body

KeyData TypeDescription
successbooleanIndicate the success of the request
msgstringMessage indicators
error_codeintError code information, only set if success is false
resultjsonResult, only set if success is true
gen_atdatetimeGenerated datetime

Types

{
"success": <boolean>,
"msg": <string>,
"error_code": <int>,
"result": <json>,
"gen_at": <datetime>
}

Sample

{
"success": true,
"msg": "Project created successfully",
"error_code": null,
"result": {
"id": "MyProject",
"name": "MyProject",
"description": "This is my project",
"is_private": true,
"user_id": "7f7c0c39-0930-43f2-81a3-29e3cffecaa4",
"algo_type": "Regression",
"algo_selected": "Multiple Linear Regression",
"shared_type": null,
"shared_with": null,
"dataset_name": null,
"model_path": null,
"model_type": null,
"encoder_path": null,
"encoder_type": null,
"community_model_url": null,
"created_at": "2023-06-01T11:44:39.798483",
"updated_at": "2023-06-01T11:44:39.798490",
"is_community_model": false
},
"gen_at": "2023-06-01T11:44:40.196245"
}