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 Upload API

Pre-signed direct-to-S3 upload lifecycle for file-sourced datasets.

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

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

This API exposes 3 operations across 3 paths, and defines 1 schema. 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.

3 operations 3 paths 1 schemas 3 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 Upload 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 3

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

Upload 3

Pre-signed direct-to-S3 upload lifecycle for file-sourced datasets.

POST
/api/v1/datasets/upload/initiate
Initiate a pre-signed file upload
initiateUpload body → 200401
POST
/api/v1/datasets/upload/complete
Complete an upload and create the dataset
completeUpload body → 200400
POST
/api/v1/datasets/{dataset_id}/upload/complete
Complete an upload for an existing dataset
completeUploadById 1 param body → 200404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorEnvelope (3 properties). Each schema is shown below with its type and property counts.

ErrorEnvelope
object
Structured error payload. code is a stable error code (e.g. E0100) when the failure was structured.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adaption-upload-api-openapi.yml Raw ↑

Other APIs Adaption publishes across the network.

Adaption Datasets API