Minikai API documentation

{
  "items": [
    {
      "item": {
        "id": "string",
        "name": "string",
        "createdBy": "string",
        "agentType": "person",
        "profilePictureUrl": "string",
        "dateOfBirth": "2023-01-15",
        "identities": [
          {
            "value": "string",
            "kind": "my_aged_care"
          }
        ],
        "externalUri": "string",
        "labels": [
          "string"
        ],
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "updatedBy": "string",
        "eTag": "string"
      },
      "matchedFields": [
        "string"
      ]
    }
  ],
  "totalCount": null,
  "nextCursor": "string"
}

Full-text search across Minis.

Authentication

AuthorizationBearer

Authenticate every request with Authorization: Bearer <api-key>. Manage keys in Workspace Admin > Security & access.

Request

This endpoint expects an object.

textstringOptional

labelslist of strings or nullOptional

agentTypeenum or nullOptional

cursorstring or nullOptional

limitanyOptional

sortenumOptional

Response

itemslist of objectsOptional

totalCountanyOptional

nextCursorstring or nullOptional

Errors

400

Bad Request Error

1	from minikai import Minikai
2
3	client = Minikai(
4	token="YOUR_TOKEN_HERE",
5	)
6
7	client.minis.search_minis()