Ximilar - MCP Server & Client

Quickstart Ximilar Platform Video Tutorials

To access the Ximilar Computer Vision Platform, register at https://app.ximilar.com first. In the App, pick "Computer Vision Platform".

This page describes User and Workspace management for the Ximilar Computer Vision Platform, a powerful solution for training custom image recognition models. Each account created via app.ximilar.com represents a user. By default, each user owns at least one workspace. However, user can have multiple workspaces. Workspace is a space where you can store your images, labels, and tasks for your project. On this page we describe how to get details about your user account, statistics, workspaces, and available solutions.

To use MCP Server & Client, you need to:

Download/Install the MCP Server & Client from here
Install python 3.10 or higher
Install the fastmcp package and requests package:

pip install fastmcp requests

Go to the file ximilar/server/mcp.py and set the XIMILAR_API_KEY environment variable to your Ximilar API key.
Run the server:

python ximilar/server/mcp.py

The following basic endpoints are useful for getting details about your user account, statistics (reports), your workspace(s), and available solutions (resource):

https://api.ximilar.com/account/v2/details/
https://api.ximilar.com/account/v2/reports/
https://api.ximilar.com/account/v2/workspace/ 
https://api.ximilar.com/account/v2/resource/

GET/v2/details/

Get User Details

This endpoint returns detailed information about the authenticated user, including personal details, usage statistics, service data, and credit information.

Required attributes

Name
Authorization
Type
string
Description
Unique API token for authentication.

Returns

HTTP error code 2XX, if the method was OK, and other HTTP error code, if the method failed. The response body is a JSON object with the following fields:

Name
id
Type
string
Description
Unique identifier of the user.
Name
email
Type
string
Description
User's email address.
Name
first_name
Type
string
Description
User's first name.
Name
last_name
Type
string
Description
User's last name.
Name
stats
Type
object
Description
Object containing usage statistics with the following fields:
Name
credits_counter
Type
integer
Description
Current number of API credits available to the user.
Name
credits_limit
Type
integer
Description
Maximum number of API credits the user can have.
Name
default_workspace
Type
string
Description
ID of the user's default workspace.

Request

GET

/v2/details/

curl --location 'https://api.ximilar.com/account/v2/details/' \
--header 'Authorization: Token __API_TOKEN__'

Response

{
  "id": "d7c949e2-c856-43b1-a8d4-f698d167cef7",
  "email": "youremail@email.com",
  "first_name": "Lorem",
  "last_name": "Ipsum",
  "stats": {
    "recognition_task": 146,
    "detection_task": 19,
    "similarity_task": 13,
    "collection": 11,
    "flow": 24
  },
  "credits_counter": 128183952,
  "credits_limit": 2147483647,
  "default_workspace": "16502315-ef71-4424-9239-697458fe8e37"
}