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

The Runs API from Instabase — 4 operation(s) for runs.

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

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

This API exposes 6 operations across 4 paths, and defines 12 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.

6 operations 4 paths 12 schemas 1 DELETE3 GET2 POST

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 Runs 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 6

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

Runs 6
POST
/v2/apps/runs
Run app
runApp 1 param body → 200default
GET
/v2/apps/runs
List runs
listRuns 14 params → 200default
POST
/v2/apps/deployments/{deployment-id}/runs
Run deployment
runDeployment 2 params body → 202default
GET
/v2/apps/runs/{run_id}
Get run status
getRunStatus 2 params → 200default
DELETE
/v2/apps/runs/{run_id}
Delete run
deleteRun 6 params → 202default
GET
/v2/apps/runs/{run_id}/results
Get run results
getRunResults 7 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are resultsResponse (11 properties), document (10 properties), run (10 properties), documentField (8 properties). Each schema is shown below with its type and property counts.

documentField
object
8 properties
pageLayout
object
3 properties 3 required
caseInfoField
object
7 properties 2 required
error
object
1 property
caseInfo
object
1 property
document
object
10 properties
resultsResponse
object
11 properties
run
object
10 properties
fileWithDocuments
object
3 properties
caseInputField
object
Input option for ranked cross-class fields.
2 properties
modificationObject
object
3 properties 2 required
fieldSourceCoordinates
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instabase-runs-api-openapi.yml Raw ↑

Other APIs Instabase publishes across the network.

Instabase Audit API
Instabase Batches API
Instabase Files API
Instabase Jobs API
Instabase Secrets API