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

OpenAIOS Platform API (Pineapple)

The REST API of OpenAIOS-Platform, 4Paradigm's Kubernetes-based AI development platform — environments, applications, Helm releases, the app store, container images, object storage, competitions, container logs and web terminals. Published as OpenAPI 3.0.3 in the openaios-platform repository; self-hosted, so servers[] names the in-cluster loopback the provider shipped.

This API exposes 43 operations across 30 paths, organized into 11 resource areas, and defines 67 schemas. It is described by OpenAPI 3.0.3, at version 0.0.1.

Requests are made against a single base URL, http://127.0.0.1:1234/api.

43 operations 30 paths 67 schemas 6 DELETE26 GET9 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.1
Base URL
http://127.0.0.1:1234/api
Authentication
OpenID Connect, API Key
Resource Areas
11

Authentication & Security 2

OpenAIOS Platform API (Pineapple) declares 2 security schemes for authenticating requests. It supports OpenID Connect (OpenID) discovered at /.well-known/openid-configuration. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 43

Across 30 paths, the API surfaces 43 operations — 6 DELETE, 26 GET, 9 POST, 2 PUT. They span 11 resource areas, including finished, users, computing_resource, environments, applications, appstore, releases, logs, and 3 more. Each is listed below with its method, path, parameters, and response codes.

finished 1
GET
/version
image version
PineappleVersion → 200
users 3
GET
/user/info
Get user info
getUser → 200404500
GET
/user/tasks
get user task info
→ 200400500
POST
/user/init
init user
→ 200400500
computing_resource 1
GET
/computing_resource/specs
Get computing unit specifications
GetComputingUnitSpecs → 200
environments 4
GET
/environments
Gets environment list
getEnvironmentList 2 params → 200
GET
/environments/{name}
Gets environment
getEnvironment 1 param → 200400500
POST
/environments/{name}
Create an environment
createEnvironment 1 param body → 200400500
DELETE
/environments/{name}
Delete an environment
deleteEnvironment 1 param → 200400500
applications 7
GET
/applications
Get application list
getApplicationList 2 params → 200500
POST
/applications/{name}
Create an app
createApplication 1 param body → 200400500
DELETE
/applications/{name}
Delete an application instance
deleteApplication 1 param → 200400500
GET
/applications/{name}/metadata
Gets a application metadata
getApplicationMetadata 1 param → 200400500
GET
/applications/{name}/pods
Gets a application pods
getApplicationPods 1 param → 200400500
GET
/applications/{name}/services
Gets a application services
getApplicationServices 1 param → 200400500
GET
/applications/{name}/notes
Gets application notes
getApplicationNotes 1 param → 200400500
appstore 3
GET
/appstore/charts
Get chart list
getAppstoreChartList → 200500
POST
/appstore/charts/{category}
Upload chart
uploadChart 1 param body → 200400500
GET
/appstore/charts/{category}/{name}/{version}
Get a chart
getAppstoreChart 3 params → 200500
releases 3
GET
/releases/{name}
Get information from specific release
getRelease 1 param → 200404500
POST
/releases/{name}
Create a release
createRelease 1 param body → 200409500
DELETE
/releases/{name}
Delete a release
deleteRelease 1 param → 200404500
logs 1
GET
/log/pod/{pod_name}
get container log
GetContainerLog 3 params → 200400500
images 11
GET
/images/importing
List importing images
ListImportingImages → 200400500
POST
/images/importing
Import images
3 params → 200400500
DELETE
/images/importing
Remove importing from list
1 param → 200400500
PUT
/images/importing
Stop importing
1 param → 200400500
GET
/images/registry
Get registry list
→ 200400500
GET
/public_images/info
Get public project info
1 param → 200400500
GET
/public_images
Get public images
3 params → 200400500
GET
/images/info
Get user project info
→ 200400500
GET
/images
Get images
2 params → 200400500
PUT
/images
Copy image
3 params → 200400500
DELETE
/images
Delete image
2 params → 200400500
competition 4
GET
/competition
list competition
2 params → 200400500
POST
/competition/{competitionID}
join competition
2 params body → 200400500
GET
/competition/{competitionID}
check joined competition
1 param → 200400500
GET
/competition/{competitionID}/invitation
get invitation number in a competition
1 param → 200400500
storage 5
GET
/storage
Get directory
getDirectory 1 param → 200400500
POST
/storage
Create directory
createDirectory 1 param → 200400500
DELETE
/storage
Delete directory or file
deleteDirectoryOrFile 1 param → 200400500
POST
/storage/upload
Upload File
1 param body → 200400500
GET
/storage/download
Download File
1 param → 200400500

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are CompetitionInfo (7 properties), ImageImportingInfo (7 properties), ChartMetadata (6 properties), ImageInfo (5 properties). Each schema is shown below with its type and property counts.

PosixPath
string
posix path for directory or file
UserName
string
user name
Password
string
password
Email
string
user email
EnvironmentName
string
environment name
ChartName
string
chart name
ReleaseName
string
release name
ImageName
string
image name
ServiceName
string
service name
PodName
string
pod name
ContainerName
string
container name
ChartVersion
string
chart version
Port
integer
port
ReleaseState
string
PodState
string
ContainerState
string
UserInfo
object
2 properties
EmailVerifyCode
string
UserLoginInfo
object
user login information
2 properties 2 required
UserRegisterInfo
object
user register information
4 properties 4 required
UserRefreshToken
object
1 property 1 required
UserTasksInfo
object
3 properties
UserTaskInfo
object
3 properties
StorageMapping
object
storage mapping
2 properties
ServiceExpose
object
service to expose
2 properties
ImageConfig
object
image configuration
3 properties
EnvironmentConfig
object
environment configuration
5 properties
EnvironmentState
string
environment state
EnvironmentRuntimeStaticInfo
object
environment runtime static information
5 properties
EnvironmentRuntimeSshInfo
object
environment runtime ssh information
2 properties
EnvironmentRuntimeInfo
object
environment runtime information
5 properties
EnvironmentRuntimeInfos
object
environment runtime information list
2 properties
ApplicationConfig
object
metadata to create an application instance
2 properties
ReleaseCreateConfig
object
metadata to create a release
3 properties
KubernetesContainer
object
container schema
3 properties
KubernetesPod
object
pod schema
5 properties
KubernetesService
object
service schema
4 properties
ChartValue
string
ChartCategory
string
chart repo category
ChartMetaDataList
object
chart metadata list
1 property
Chart
object
chart
3 properties
ChartMetadata
object
chart metadata
6 properties
ChartFiles
object
chart files
ApplicationList
object
application instance list
2 properties
ApplicationInstanceMetadata
object
application instance
5 properties
ApplicationInstancePodList
object
application instance pod list
2 properties
ApplicationInstancePod
object
application instance pod
5 properties
ApplicationInstanceEvent
object
application instance event
5 properties
ApplicationInstanceContainer
object
application instance container
4 properties
ApplicationInstanceServiceList
object
application instance service list
2 properties
ApplicationInstanceService
object
application instance pod
5 properties
LongDescription
string
long description including newlines
ShortDescription
string
short description excluding newlines
ImageRegistryInfo
object
image registry info
2 properties
ImageRepo
string
image repo
ImageTag
string
image tag
ImageImportingId
integer
image importing ID
ImageImportingInfo
object
import image info
7 properties
ImageInfo
object
image info
5 properties
ProjectUserInfo
object
user repo info
1 property
MemorySpec
string
memory spec
ComputeUnitId
string
compute unit name
ComputeUnitSpec
object
compute unit spec
4 properties
DomainType
string
private or public
FileInfo
object
file or directory info
4 properties
FileType
string
file type for upload and Download
CompetitionInfo
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

4paradigm-openaios-platform.yaml Raw ↑
Where this information came from

This is an independent, third-party profile of OpenAIOS Platform API (Pineapple), 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.