Get Started#

In this section you will be informed on how to interact programmatically with the Intel® Geti™ platform to leverage its capabilities in handling datasets, annotations, and more.

Note

Intel® Geti™ Platform Host address:

For Intel® Geti™ SaaS please use https://app.geti.intel.com/ as host address, for Intel® Geti™ on-premise please use the server IP address or your DNS domain provided during the installation.

If you don’t have an Intel Geti SaaS account, you can request access by filling this form https://geti.intel.com/request-trial.

Obtain access#

Before you can start interacting with the Intel® Geti™ REST API, you first must obtain access to the API by creating a Personal Access Token.

To get the token:

  1. Go the Intel® Geti™ user interface.

  2. Go to the Account section on the side panel and click on Token tab.

  3. Click Create. A dialog box will prompt you to specify an expiration date for the token.

Obtaining Personal Access Token

Warning

After closing the dialog box, you will not be able to retrieve your token. So, remember to copy your token.

The token generated through this method is essential for authenticating requests to the Intel® Geti™ API.

To utilize it, simply include this token in the request header of your subsequent API calls.

This is done by adding x-api-key: <token> to the header of each request. This process ensures that your requests are securely authenticated.

Obtaining the Organization and Workspace IDs#

Within Intel® Geti™, projects belong to workspace, and workspace belongs to organizations. Currently we support one workspace per organization.

To interact with a project, we need to determine the organization_id and workspace_id that it belongs to.

Relation between Organization, Workspace and Projects

Note

You can also retrieve organization_id and workspace_id from URL when using Intel® Geti™ UI.

When logging in to Intel® Geti™ you will be redirected to the main page, being the default workspace of your organization.

<YOUR_HOST_ADDRESS>/organizations/{organization_id}/workspaces/{workspace_id}


First, we make a GET request to the personal_access_tokens/organization endpoint which will return us a response containing the ID of the organization that you have access to.

Obtaining Organization ID

After that, we make a GET request to /organizations/{organization_id}/workspaces/ in order to obtain the list of workspaces in the organization. Choose the workspace you want to use and get the workspace_id from the response.

Obtaining Workspace ID

Once you complete obtaining access to REST API and organization and workspace IDs, you are successfully authenticated and ready to interact with our REST API.

REST API Tutorial with Swagger#

Once you successfully obtained access to the REST API and got both organization and workspace IDs, you are ready to interact with our REST API.

Example: Retrieving all projects from a workspace:#

  1. Navigate to REST API Specification.

  2. Click Authorize button and paste the generated Personal Access Token.

Authorize requests in Swagger
  1. Find Projects section and browse through the listed endpoints, find GET /organizations/{organization_id}/workspaces/{workspace_id}/projects and click it.

  1. Click Try it out.

  1. Fill the request parameters form with your organization_id and workspace_id that you previously generated and click Execute.

  1. Below, under Server Response you will find a response in JSON format, containing all projects information from your workspace.

  1. In case of issues with the response, please check Responses to understand what might have caused the issue.

REST API Reference#

The REST API is written in OpenAPI specification (OAS). The OAS allows for a high level of flexibility regarding tooling and plugging into your current workflow.

We provide you with the generated REST API reference, however, you can also download the specification and use your preferred tool.

All you need to do is to download the OpenAPI specification (you can download a JSON file from here under openapi.json) and import it to your tool of choice.