Get Started#

Interact with Intel® Geti™ programmatically to upload and download datasets, create annotations for images and video frames.

Note

The base URL in the endpoints is your IP address or your DNS domain you provided during the installation.

Important

For most endpoints in the following guides, you will need your workspace ID. You can get it through this endpoint GET {baseUrl}/workspaces/{workspace_id}/projects. However, for the time being you can pass any string (e.g. “dummy”) as the value for the path variable since the installer automatically creates one default workspace. There is no support for multiple workspaces.

Obtain access#

Before you can start interacting with the Intel® Geti™ API, you first must obtain access to the API. There are two steps to obtain it.

  1. Get Personal access token

  2. Call the authentication endpoint

1. Get a Personal Access Token#

To get a Personal Access Token, go the Intel® Geti™ user interface, go to the Profile section, and click on Personal Access Token tab. You will see a page with available tokens or lack thereof. You need to first create the token by clicking on Create. A dialog box will prompt you to specify an expiration date for the token. After selecting the date, press Create.

Warning

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

A user can only generate one Personal Access Token. If they want to create another one, the previously created token must be removed to create a new one.

2. Call the authentication endpoint#

You can do this with the authentication endpoint. What you need to do is call the authentication endpoint

POST
{baseUrl}/service_accounts/access_token

and provide your service_id string (Personal Access Token, consisting of two 32-character codes obtained from the UI) in the request body e.g.

{
"service_id": "<32-character code:32-character code>"
}

Upon receiving 200 “Successfully authenticated” in the response body, copy the access_token value, and add it to the request header (Authorization: Bearer <token>) for the coming requests to authenticate them. The authentication session lasts for 15 minutes. However, you can configure it to automatically refresh after the session. Note that the API does not allow concurrent users.

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.