Projects management

Endpoints to interact with your projects and their content

post
Create a Project

https://api.expai.io/api/projects/create
Create new project
Request
Response
Request
Headers
access-token
required
string
Active JWT token
Content-Type
required
string
Value: "application/json"
Body Parameters
project_name_des
required
string
Name for your project
project_description_des
required
string
Description for your project
Response
200: OK
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"
}

get
List all Projects

https://api.expai.io/api/projects/list
List all projects in your organization
Request
Response
Request
Headers
access-token
required
string
Active JWT token
Content-Type
required
string
Value: "application/json"
Response
200: OK
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
}]
}

get
Search Projects by name

https://api.expai.io/api/projects/list/contains/<text>
List all projects in your organization containing a string in their names
Request
Response
Request
Path Parameters
text
required
string
String to search Projects by
Headers
access-token
required
string
Active JWT token
Content-Type
required
string
Value: "application/json"
Response
200: OK
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
}]
}

patch
Update Project

https://api.expai.io/api/projects/<project_id>
Update metadata in an existing project
Request
Response
Request
Path Parameters
project_id
required
string
Project to be modified unique identifier
Headers
access-token
required
string
Active JWT token
Content-Type
required
string
Value: "application/json"
Form Data Parameters
project_name_des
optional
string
New name for the project
project_description_des
optional
string
New description for the project
Response
204: No Content
Successful modification
{
"code": "success",
"http_code": 204,
"message": "success"
}

delete
Delete Project

https://api.expai.io/api/projects/<project_id>
Delete a Project in your organization
Request
Response
Request
Headers
access-token
required
string
Active JWT token
Response
204: No Content
Successful deletion
{
"code": "success",
"http_code": 204,
"message": "success"
}

‚Äč