Oslo Logo
API docs by Redocly

Oslo API (1.0)

Download OpenAPI specification:Download

Oslo Support Team: [email protected] URL: https://oslo.vision

API for the Oslo project, a platform for creating and managing datasets for machine learning projects. The API allows you to upload images, annotate them, and manage the datasets. The API is secured with a bearer token, which you can obtain by signing up on the website. The API is still in development, and new features will be added in the future.

Add an image to the project.

Add an image to the project. You can either upload an image in the request, or pass a URL of the image. The project_identifier is the project you want to add the image to. The response if successful contains the ID of the image you uploaded. This can be used to reference the image in the annotation endpoint. You can also pass a split parameter, which is used to split the image into a training or validation set.

Authorizations:
bearerAuth
Request Body schema: multipart/form-data

Request body for adding an image to the project. You can either upload an image or pass a URL of the image. The project_identifier is the project you want to add the image to. The split parameter is used to split the image into a training or validation set.

project_identifier
required
string

The project identifier you want to add the image to.

image
string <binary>

The image file you want to upload.

url
string

The URL of the image you want to add, not required if you upload an image.

split
string
Default: "train"
Enum: "train" "val" "test"

The split of the image, can be train, val, or test.

status
string
Default: "pending"
Enum: "pending" "dataset"

Whether the image should be added to the dataset or be pending for review.

Responses

Response samples

Content type
application/json
{
  • "id": "sdfsdffd",
  • "url": "string",
  • "split": "string",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

API Route Endpoint

API Route Endpoint, useful for testing if the API is up and running and your token is valid.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "msg": "Hello World!"
}

Create a new annotation

Create a new annotation, this requires you have already uploaded an image, which you can reference by the image_identifier. The label is the class of the object you are annotating, and the x0, y0, width_px, height_px are the bounding box coordinates.

Authorizations:
bearerAuth
Request Body schema:
project_identifier
required
string

The project identifier you want to add the annotation to.

image_identifier
required
string

The image identifier you want to annotate.

label
required
string

The label of the object you are annotating.

x0
required
number

The x-coordinate of the top-left corner of the bounding box.

y0
required
number

The y-coordinate of the top-left corner of the bounding box.

width_px
required
number

The width of the bounding box in pixels.

height_px
required
number

The height of the bounding box in pixels.

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "id": "string",
  • "image_identifier": "string",
  • "label": "string",
  • "x0": 0,
  • "y0": 0,
  • "width_px": 0,
  • "height_px": 0,
  • "color": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Download an export

Download an export from the dataset. This has already been preprocessed and is ready for training.

Authorizations:
bearerAuth
path Parameters
version
required
integer

The version of the export you want to download.

query Parameters
project_identifier
required
string

The project identifier you want to download the export from.

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}