Projects management

Endpoints to interact with your projects and their content

Create a Project

POST https://api.expai.io/api/projects/create

Create new project

Headers

Name	Type	Description
access-token	string	Active JWT token
Content-Type	string	Value: "application/json"

Request Body

Name	Type	Description
project_name_des	string	Name for your project
project_description_des	string	Description for your project

200 Successful project creation

{
    "code": "success",
    "created_by_user_id": "<YOUR-USER-ID>",
    "http_code": 201,
    "id": 26,
    "message": "Resource created",
    "organization_id": "<YOUR-ORGANIZATION-ID>",
    "project_description_des": "This is the second project I've made",
    "project_id": "3e5208fc-5aaf-4b58-9b3e-adf9cff0de41",
    "project_name_des": "My project"
}

curl --location --request GET 'http://yourInstance/api/projects/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project_name_des": "My first project",
    "project_description_des": "This is the first project I'\''ve made"
}

List all Projects

GET https://api.expai.io/api/projects/list

List all projects in your organization

Headers

Name	Type	Description
access-token	string	Active JWT token
Content-Type	string	Value: "application/json"

200 Example of a project list containing 1 element.

{
    "code": "success",
    "http_code": 200,
    "message": "success",
    "projects": [
        {
            "created_on_dt": "Tue, 13 Apr 2021 16:21:51 GMT",
            "explanations_count": 1,
            "models_allowed_num": 10,
            "models_count": 3,
            "models_created_num": 5,
            "modified_on_dt": null,
            "project_description_des": "<MY-DESCRIPTION>",
            "project_id": "3620945a-d2ca-4d4e-af4e-e310e5120f48",
            "project_name_des": "My project",
            "samples_count": 2
        }]
}

Search Projects by name

GET https://api.expai.io/api/projects/list/contains/<text>

List all projects in your organization containing a string in their names

Path Parameters

Name	Type	Description
text	string	String to search Projects by

Headers

Name	Type	Description
access-token	string	Active JWT token
Content-Type	string	Value: "application/json"

200 Example of a project list containing 1 element.

{
    "code": "success",
    "http_code": 200,
    "message": "success",
    "projects": [
        {
            "created_on_dt": "Tue, 13 Apr 2021 16:21:51 GMT",
            "explanations_count": 1,
            "models_allowed_num": 10,
            "models_count": 3,
            "models_created_num": 5,
            "modified_on_dt": null,
            "project_description_des": "<MY-DESCRIPTION>",
            "project_id": "3620945a-d2ca-4d4e-af4e-e310e5120f48",
            "project_name_des": "My project",
            "samples_count": 2
        }]
}

Update Project

PATCH https://api.expai.io/api/projects/<project_id>

Update metadata in an existing project

Path Parameters

Name	Type	Description
project_id	string	Project to be modified unique identifier

Headers

Name	Type	Description
access-token	string	Active JWT token
Content-Type	string	Value: "application/json"

Request Body

Name	Type	Description
project_name_des	string	New name for the project
project_description_des	string	New description for the project

204 Successful modification

{
    "code": "success",
    "http_code": 204,
    "message": "success"
}

Delete Project

DELETE https://api.expai.io/api/projects/<project_id>

Delete a Project in your organization

Headers

Name	Type	Description
access-token	string	Active JWT token

204 Successful deletion

{
    "code": "success",
    "http_code": 204,
    "message": "success"
}