Create project

You can create OmniMind through the API, then add content to it and start querying it.

To create a project, you must send a request of the multipart/form-data type.

In the request, indicate the name of the new project and your private key omni_key.

Parameters


"omni_key"  is the private key.
You can generate a personal key in your profile settings on the platform. Instructions on how to do this can be found here> API key

name Enter the name of the project.

Returns


Returns a "is_public": true object if creation succeeds.

/rest/v1/projects
Example
{
  "omni_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNGFiNDUyYTMtNGMwYi00MTIyLWI3NDgtYzk4MWRiN2VlYWFlIiwiZGVmYXVsdFJvbGUiOiJ1c2VyIiwiYWxsb3dlZFJvbGVzIjpbInVzZXIiLCJtZSJdfSwiaWF0IjoxNzE0MTM2ODI5LCJleHAiOjE3NDU2OTQ0MjksInN1YiI6IjRhYjQ1MmEzLTRjMGItNDEyMi1iNzQ4LWM5ODFkYjdlZWFhZSJ9._GROLq9wBmp29S3RDQs2_x7nd1GqATyOM7ijhm5tURc",
  "name": "Projnew"
}
Schema
{
  "omni_key": "string",
  "name": "string"
}

Responses

Successful operation

Example
{
    "id": "4b4937ce-2a37-4143-97ef-c689a43e70a8",
    "name": "Projnew",
    "is_public": false,
    "created_at": "2024-04-26T13:12:24.692852+00:00",
    "updated_at": "2024-04-26T13:12:24.692852+00:00"
}
Schema
{
"id":	"string"($uuid)
"name":	"string",
"is_public":	"boolean",
"updated_at":	{
    oneOf ->	string($date)
              string($date-time)
              }
"created_at":	{
    oneOf ->	string($date)
              string($date-time)
              }
}

Was this article helpful to you? Yes No

How can we help?