Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adaption Datasets API

Create, list, run, evaluate, download, and publish adaptive datasets.

Adaption Datasets API is one of 2 APIs that Adaption publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Datasets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 8 operations across 7 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 0.4.0.

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

8 operations 7 paths 18 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.4.0
Base URL
https://api.prod.adaptionlabs.ai
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Adaption Datasets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Send your Adaption API key as a Bearer token: Authorization: Bearer . Keys are created in the app (Settings, API keys) and are prefixed ptlive.

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Datasets 8

Create, list, run, evaluate, download, and publish adaptive datasets.

POST
/api/v1/datasets
Create a dataset
createDataset body → 200400401422429
GET
/api/v1/datasets
List datasets
listDatasets 8 params → 200401429
GET
/api/v1/datasets/{dataset_id}
Get a dataset
getDataset 1 param → 200401404
GET
/api/v1/datasets/{dataset_id}/status
Get dataset processing status
getDatasetStatus 1 param → 200404
GET
/api/v1/datasets/{dataset_id}/evaluation
Get dataset quality evaluation
getDatasetEvaluation 1 param → 200404
POST
/api/v1/datasets/{dataset_id}/run
Run the adaptation pipeline (or estimate its cost)
runDataset 1 param body → 200400404422429
GET
/api/v1/datasets/{dataset_id}/download
Download the adapted dataset
downloadDataset 2 params → 200404
POST
/api/v1/datasets/{dataset_id}/publish
Publish the dataset to HuggingFace or Kaggle
publishDataset 1 param body → 200404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Dataset (12 properties), DatasetListItem (7 properties), DatasetRunParams (7 properties), DatasetRunResponse (6 properties). Each schema is shown below with its type and property counts.

DatasetGetEvaluationResponse
object
4 properties 1 required
DatasetCreateResponse
object
3 properties 2 required
Progress
object
Processing progress. Null when no run is active.
3 properties
EvaluationSummary
object
Compact evaluation summary. Null if evaluation has not completed.
5 properties
DatasetCreateParams
object
1 property 1 required
HuggingfaceSource
object
3 properties 3 required
DatasetGetStatusResponse
object
5 properties 2 required
KaggleSource
object
3 properties 3 required
DatasetPublishParams
object
2 properties 1 required
ErrorEnvelope
object
Structured error payload. code is a stable error code (e.g. E0100) when the failure was structured.
3 properties
DatasetRunResponse
object
6 properties 4 required
ConfiguredColumnMapping
object
User-configured column mapping. Null if not yet configured.
5 properties
ErrorData
object
Error details if the dataset failed. Null otherwise.
3 properties
DatasetRunParams
object
7 properties
DatasetListItem
object
7 properties 4 required
FileSource
object
3 properties 3 required
DatasetPublishResponse
object
3 properties 2 required
Dataset
object
12 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adaption-datasets-api-openapi.yml Raw ↑

Other APIs Adaption publishes across the network.

Adaption Upload API