JarvisLabs Instances API
GPU and CPU instance lifecycle.
JarvisLabs Instances API is one of 5 APIs that JarvisLabs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Instances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 7 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://api.jarvislabs.ai/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
JarvisLabs Instances API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— API token generated at https://jarvislabs.ai/settings/api-keys. In the SDK this is set via jarvisclient.token; the CLI stores it via jl setup.
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
GPU and CPU instance lifecycle.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Instance (13 properties), CreateInstanceRequest (13 properties), ResumeInstanceRequest (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from JarvisLabs 4
Other APIs JarvisLabs publishes across the network.