Minds Cloud Docs

POST/api/v1/minds

Create Mind

This endpoint creates a Mind.

Path parameters

None.

Authorization

Name
MINDS_API_KEY
Type
string
Required
Description
Generate the Minds API key here and use it for authorization.

Request body

Name
name
Type
string
Required
Description
Provide a unique name for the Mind.
Name
datasources
Type
array
Required
Description
Provide a list of data sources to be connected to the Mind. Use this endpoint to create data sources.
Name
parameters
Type
object
Description
Optional configuration parameters for the Mind. Supported keys:
- system_prompt (string) — Custom system prompt/instructions that guide how the Mind responds to queries.
- prompt_template (string) — Alternative to system_prompt. If both are provided, system_prompt takes precedence.
- is_demo (boolean) — Flag to mark the Mind as a demo mind, used for filtering.
- allow_direct_queries (boolean) — Whether to allow direct SQL queries via the sql_query tool in the Responses API. Defaults to false.

Request

POST

/api/v1/minds

curl --request POST \
--url 'https://mdb.ai/api/v1/minds' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MINDS_API_KEY' \
--data '{
    "name": "mind_name",
    "datasources": [
      "datasource_with_all_its_tables",
      {"name": "datasource_with_selected_tables", "tables": ["table_name", ...]},
      ...
    ],
    "parameters": {
      "system_prompt": "Answer questions about sales data in a concise way",
      "allow_direct_queries": false
    }
}'

Response

200 OK

GET/api/v1/minds

List Minds

This endpoint lists all created Minds.

Path parameters

None.

Authorization

Name
MINDS_API_KEY
Type
string
Required
Description
Generate the Minds API key here and use it for authorization.

Request body

None.

Request

GET

/api/v1/minds

curl --request GET \
--url 'https://mdb.ai/api/v1/minds' \
--header 'Authorization: Bearer MINDS_API_KEY'

Response

[
    {
        "created_at": "Wed, 07 Aug 2024 10:50:31 GMT",
        "datasources": [
        "datasource_name"
        ],
        "model_name": "gpt-4o",
        "name": "mind_name",
        "parameters": {},
        "provider": "openai",
        "updated_at": "Wed, 07 Aug 2024 16:43:21 GMT"
    },
    ...
]

GET/api/v1/minds/{mind_name}

Get Mind

This endpoint lists details about a Mind.

Path parameters

Name
mind_name
Type
string
Required
Description
Provide the name of the Mind.

Authorization

Name
MINDS_API_KEY
Type
string
Required
Description
Generate the Minds API key here and use it for authorization.

Request body

None.

Request

GET

/api/v1/minds/{mind_name}

curl --request GET \
--url 'https://mdb.ai/api/v1/minds/mind_name' \
--header 'Authorization: Bearer MINDS_API_KEY'

Response

{
    "created_at": "Thu, 12 Sep 2024 12:37:16 GMT",
    "datasources": [],
    "model_name": "gpt-4o",
    "name": "mind_name",
    "parameters": {},
    "provider": "openai",
    "updated_at": "Thu, 12 Sep 2024 12:37:16 GMT"
}

PUT/api/v1/minds/{mind_name}

Update Mind

This endpoint updates the Mind name, connected data sources, and/or parameters.

Path parameters

Name
mind_name
Type
string
Required
Description
Provide the name of the Mind.

Authorization

Name
MINDS_API_KEY
Type
string
Required
Description
Generate the Minds API key here and use it for authorization.

Request body

Name
name
Type
string
Description
Provide a new name for the Mind.
Name
datasources
Type
array
Description
Provide an updated list of data sources to be connected to the Mind. Use this endpoint to create data sources.
Name
parameters
Type
object
Description
Updated configuration parameters for the Mind. See the Create Mind endpoint for supported keys.

Request

PUT

/api/v1/minds/{mind_name}

curl --request PUT \
--url 'https://mdb.ai/api/v1/minds/mind_name' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MINDS_API_KEY' \
--data '{
    "name": "mind_name_new",
    "datasources": ["datasource_name"],
    "parameters": {
      "allow_direct_queries": true
    }
}'

Response

200 OK

DELETE/api/v1/minds/{mind_name}

Delete Mind

This endpoint deletes a Mind.

Path parameters

Name
mind_name
Type
string
Required
Description
Provide the name of the Mind.

Authorization

Name
MINDS_API_KEY
Type
string
Required
Description
Generate the Minds API key here and use it for authorization.

Request body

None.

Request

DELETE

/api/v1/minds/{mind_name}

curl --request DELETE \
--url 'https://mdb.ai/api/v1/minds/mind_name' \
--header 'Authorization: Bearer MINDS_API_KEY'

Response

200 OK