How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightly Samples API

Manage samples and their signed read / write URLs within a dataset.

Lightly Samples API is one of 8 APIs that Lightly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Samples. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.lightly.ai.

6 operations 4 paths 4 schemas 4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.lightly.ai/v1
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Lightly Samples API declares 2 security schemes for authenticating requests. An API key is passed in the query as token (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — LightlyOne API token passed as the token query parameter. Find your token in the preferences menu of the LightlyOne Platform.
  • BearerAuth — Public JWT bearer token passed in the Authorization: Bearer header for browser / public-token authenticated calls.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Samples 6

Manage samples and their signed read / write URLs within a dataset.

GET
/v1/datasets/{datasetId}/samples
List samples in a dataset.
getSamplesByDatasetId 1 param → 200
POST
/v1/datasets/{datasetId}/samples
Create a sample in a dataset.
createSampleByDatasetId 1 param body → 201
GET
/v1/datasets/{datasetId}/samples/{sampleId}
Get a sample by id.
getSampleById 2 params → 200
PUT
/v1/datasets/{datasetId}/samples/{sampleId}
Update a sample by id.
updateSampleById 2 params body → 200
GET
/v1/datasets/{datasetId}/samples/{sampleId}/readurl
Get a signed read URL for a sample image.
getSampleImageReadUrlById 3 params → 200
GET
/v1/datasets/{datasetId}/samples/{sampleId}/writeurl
Get a signed write URL for a sample image.
getSampleImageWriteUrlById 3 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SampleData (9 properties), SampleCreateRequest (4 properties), SampleUpdateRequest (2 properties), CreateEntityResponse (1 property). Each schema is shown below with its type and property counts.

SampleCreateRequest
object
4 properties 1 required
SampleUpdateRequest
object
2 properties
CreateEntityResponse
object
1 property 1 required
SampleData
object
9 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightly-ai-samples-api-openapi.yml Raw ↑

Other APIs Lightly publishes across the network.

Lightly Self-Supervised Learning SDK (OSS)
Lightly Datasets API
Lightly Datasources API
Lightly Embeddings API
Lightly Jobs API
Lightly Selection API
Lightly Tags API
Where this information came from

This is an independent, third-party profile of Lightly Samples API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.