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

Instabase Batches API

The Batches API from Instabase — 8 operation(s) for batches.

Instabase Batches API is one of 6 APIs that Instabase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Batches. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 11 operations across 8 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against a single base URL, https://aihub.instabase.com/api.

11 operations 8 paths 8 schemas 2 DELETE4 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://aihub.instabase.com/api
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Bearer HTTP authentication.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Batches 11
POST
/v2/batches
Create batch
createBatch 1 param body → 200default
GET
/v2/batches
List batches
listBatches 5 params → 200
GET
/v2/batches/{batch_id}
Get batch information
getBatch 2 params → 200404
DELETE
/v2/batches/{batch_id}
Delete batch
deleteBatch 2 params → 202404
GET
/v2/batches/{batch_id}/files
List files in a batch
listFiles 4 params → 200404
PUT
/v2/batches/{batch_id}/files/{filename}
Upload file to batch
addFileToBatch 3 params body → 204404default
DELETE
/v2/batches/{batch_id}/files/{filename}
Delete file from batch
deleteFileFromBatch 3 params → 202404
POST
/v2/batches/multipart-upload
Start multipart upload session
createMultipartUploadSession 1 param body → 201404default
PUT
/v2/batches/multipart-upload/sessions/{session_id}/parts/{part_num}
Upload part to multipart session
uploadMultipartPart 3 params body → 201default
POST
/v2/batches/multipart-upload/sessions/{session_id}
Commit or abort multipart session
commitMultipartUploadSession 2 params body → 201default
GET
/v2/batches/jobs/{job_id}
Poll batches job
pollBatchesJob 2 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are batchInfo (9 properties), listBatchFilesResponse (3 properties), multipartUploadSessionResponse (2 properties), multipartUploadPartResponse (2 properties). Each schema is shown below with its type and property counts.

listBatchFilesResponse
object
3 properties
error
object
1 property
batch
object
1 property 1 required
jobStatusResponse
object
2 properties
batchInfo
object
9 properties 2 required
multipartUploadSessionResponse
object
2 properties 2 required
batchDeletionJobResponse
object
1 property 1 required
multipartUploadPartResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instabase-batches-api-openapi.yml Raw ↑

Other APIs Instabase publishes across the network.

Instabase Audit API
Instabase Files API
Instabase Jobs API
Instabase Runs API
Instabase Secrets API