How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shadeform Instances API

Launch and manage GPU instances across clouds.

Shadeform Instances API is one of 5 APIs that Shadeform 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 6 operations across 6 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.shadeform.ai/v1.

6 operations 6 paths 17 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.shadeform.ai/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Shadeform Instances API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key issued from the Shadeform dashboard.

Paths & Operations 6

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

Instances 6

Launch and manage GPU instances across clouds.

GET
/instances
List instances
listInstances → 200401
POST
/instances/create
Create an instance
createInstance body → 200400401
GET
/instances/{id}/info
Get instance info
getInstance 1 param → 200401404
POST
/instances/{id}/restart
Restart an instance
restartInstance 1 param → 200401404
POST
/instances/{id}/update
Update an instance
updateInstance 1 param body → 200400401404
POST
/instances/{id}/delete
Delete an instance
deleteInstance 1 param → 200401404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Instance (23 properties), CreateInstanceRequest (14 properties), Configuration (8 properties), DockerConfiguration (7 properties). Each schema is shown below with its type and property counts.

RegistryCredentials
object
2 properties
LaunchConfiguration
object
3 properties 1 required
Alert
object
Triggers that send an alert (e.g. email) for the instance.
3 properties
PortMapping
object
2 properties
AutoDelete
object
Triggers that automatically delete the instance.
2 properties
Error
object
2 properties
UpdateInstanceRequest
object
4 properties
InstancesResponse
object
1 property
DockerConfiguration
object
7 properties 1 required
ScriptConfiguration
object
1 property 1 required
VolumeMount
object
2 properties
CreateInstanceResponse
object
1 property 1 required
Env
object
2 properties
BootTime
object
2 properties
Instance
object
23 properties 15 required
Configuration
object
Hardware and OS configuration of an instance type or instance.
8 properties
CreateInstanceRequest
object
14 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shadeform-instances-api-openapi.yml Raw ↑

Other APIs Shadeform publishes across the network.

Shadeform Instance Types API
Shadeform SSH Keys API
Shadeform Templates API
Shadeform Volumes API
Where this information came from

This is an independent, third-party profile of Shadeform Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.