Platform – User Management

QuickstartXimilar PlatformVideo 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.

Useful Endpoints

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"
}
GET/v2/reports/

Get User Statistics

This endpoint returns detailed statistics about the user's API usage, including request types and sub-resources. The data can be filtered by service, time period, and time granularity (e.g., day, month, etc.).

Required attributes

  • Name
    Authorization
    Type
    string
    Description

    Unique API token for authentication.

  • Name
    type
    Type
    string
    Description

    Type of statistics to retrieve. Can be one of the following:

    • request_types – Statistics about different types of API requests (must be used with services parameter).
    • sub_resources – Statistics about sub-resources (no services parameter should be specified).

Optional attributes

  • Name
    services
    Type
    string
    Description

    Slug of the service to filter statistics by. If you're not sure about the service slug, contact tech@ximilar.com.

  • Name
    granularity
    Type
    string
    Description

    Time granularity for the statistics. Can be:

    • hour – hourly statistics
    • day – daily statistics
    • week – weekly statistics
    • month – monthly statistics
  • Name
    period_start
    Type
    string
    Description

    Start date and time for the statistics period in ISO 8601 format (e.g., "2025-03-01T00:00:00.000Z").

  • Name
    period_end
    Type
    string
    Description

    End date and time for the statistics period in ISO 8601 format. If not specified, the current date and time is used.

Returns

HTTP error code 2XX, if the method was OK and other HTTP error code, if the method failed. Body of the response is a JSON object containing statistics data based on the requested parameters.

Request

GET
/v2/reports/
curl --location 'https://api.ximilar.com/account/v2/reports/?type=request_types&services=card-grader&granularity=month&period_start=2025-03-01T00:00:00.000Z' \
--header 'Authorization: Token __API_TOKEN__'

Response

{
  "period_start": "2025-03-01T00:00:00Z",
  "period_end": "2025-04-23T09:02:27.652110Z",
  "granularity": "month",
  "x": [
    "2025-03-01T00:00:00Z",
    "2025-04-01T00:00:00Z"
  ],
  "total": {
    "credits": 44950.0,
    "records": 527
  },
  "series": [
    {
      "id": "condition",
      "name": "Asess card condition",
      "credits": [
        2700.0,
        2000.0
      ],
      "requests": [
        54,
        40
      ]
    },
    {
      "id": "grade-centering",
      "name": "Centering of card",
      "credits": [
        2050.0,
        1000.0
      ],
      "requests": [
        41,
        20
      ]
    },
    {
      "id": "grade-card",
      "name": "Grade a card",
      "credits": [
        13400.0,
        23800.0
      ],
      "requests": [
        134,
        238
      ]
    }
  ]
}
GET/v2/workspace

Get Workspaces

This endpoint returns a list of all workspaces that the authenticated user has access to. A workspace is where all your images, labels, and tasks are stored. By default, each user owns at least one workspace. You can share your workspace and grant access to other users.

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. Body of the response is a JSON array with workspace objects, each containing the following fields:

  • Name
    id
    Type
    string
    Description

    Unique identifier of the workspace. Each user has at least one workspace. By default, you don't have to specify the workspace id in the request.

  • Name
    name
    Type
    string
    Description

    Name of the workspace.

  • Name
    created
    Type
    string
    Description

    Creation timestamp in ISO 8601 format.

  • Name
    owner
    Type
    string
    Description

    User ID of the workspace owner.

  • Name
    meta_data
    Type
    object
    Description

    Additional metadata for the workspace, can be null.

  • Name
    is_default
    Type
    boolean
    Description

    Whether this is the default workspace for the user.

  • Name
    blur_images
    Type
    boolean
    Description

    Whether images in this workspace should be blurred.

Request

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

Response

[
  {
    "id": "e5b26c2c-21b9-4fbb-ab75-a5966c3cba02",
    "name": "Default",
    "created": "2022-01-18T11:57:49.046245Z",
    "owner": "4a5a6366-84c9-47b9-b302-8c32da13ced0",
    "meta_data": null,
    "is_default": true,
    "blur_images": false
  },
  {
    "id": "c9f55ec4-f0c4-4bd3-9ea6-9388754dadad",
    "name": "Workspace X",
    "created": "2023-11-03T12:24:31.769290Z",
    "owner": "d7c949e2-c856-43b1-a8d4-f698d167cef7",
    "meta_data": null,
    "is_default": false,
    "blur_images": false
  }
]
GET/v2/resource/

Get User Resources

This endpoint returns a list of all services that the authenticated user has access to. This includes both standard solutions and custom services that have been created specifically for the user.

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
    count
    Type
    integer
    Description

    Total number of resources available to the user.

  • Name
    next
    Type
    string
    Description

    URL for the next page of results, or null if there are no more pages.

  • Name
    previous
    Type
    string
    Description

    URL for the previous page of results, or null if this is the first page.

  • Name
    results
    Type
    array
    Description

    An array of resource objects with id, service and created fields.

Request

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

Response

{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 16472,
      "service": {
        "id": 33,
        "name": "AI Recognition of Collectibles",
        "slug": "collectibles-recognition"
      },
      "created": "2024-06-11T19:20:22.755727Z"
    },
    {
      "id": 16574,
      "service": {
        "id": 40,
        "name": "OCR",
        "slug": "ocr"
      },
      "created": "2024-06-24T20:04:45.718000Z"
    },
    {
      "id": 16954,
      "service": {
        "id": 0,
        "name": "Image Classification & Regression",
        "slug": "custom-recognition"
      },
      "created": "2024-08-06T08:16:13.267323Z"
    },
    {
      "id": 17219,
      "service": {
        "id": 44,
        "name": "Fashion Search & Recommendation",
        "slug": "fashion-search"
      },
      "created": "2025-02-14T11:36:42.631717Z"
    }
  ]
}

Was this page helpful?