Get Started#

Interact programmatically with the Intel® Geti™ platform to leverage its capabilities in handling datasets, annotations, and more.

Obtain access#

Before you can start interacting with the Intel® Geti™ API, you first must obtain access to the API by creating an API 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.

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.

Once you complete this, you are successfully authenticated and ready to interact with our REST API.

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 download the specification and use your preferred tool. All you need to do is download the OpenAPI specification (you can download a JSON file from here and import it to your tool of choice.