PhariaOS is a resource management system that oversees the entire lifecycle of AI resources, from inception to maintenance. The Manager API covers cluster GPUs, nodes and taints, use cases and deployments, foundation models, inference runtimes and model registration. Published as a Swagger 2.0 definition.
{
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"description": "A powerful resource management system that oversees the entire lifecycle of resources, from inception to maintenance, while efficiently integrating them with the appropriate PhariaOS. Additionally, this program takes charge of seamless application deployments, ensuring smooth operations throughout.",
"title": "PhariaOS Manager API",
"contact": {
"name": "Aleph Alpha",
"url": "https://www.aleph-alpha.com"
},
"version": "1.0"
},
"host": "api.pharia.example.com",
"basePath": "/v1/os",
"paths": {
"/cluster/gpus": {
"get": {
"description": "Retrieve the available GPU resources for the cluster",
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Get available GPU resources",
"parameters": [
{
"type": "string",
"description": "Sort GPUs ascending (asc) or descending (desc). Ascending is the default.",
"name": "sort",
"in": "query"
},
{
"type": "string",
"description": "Group GPUs by profileName or product",
"name": "groupBy",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/dtos.Gpu"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/cluster/nodes": {
"get": {
"description": "Retrieve all cluster nodes information",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "List all cluster nodes",
"parameters": [
{
"type": "integer",
"format": "int",
"default": 10,
"name": "limit",
"in": "query"
},
{
"type": "integer",
"format": "int",
"default": 1,
"name": "page",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dtos.NodePaginatedResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/cluster/nodes/taints": {
"get": {
"description": "Retrieve the taints of a cluster node",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Get node taints",
"parameters": [
{
"type": "boolean",
"description": "Filter nodes with GPU",
"name": "gpu",
"in": "query"
},
{
"type": "string",
"description": "Sort taints ascending (asc) or descending (desc). Ascending is the default.",
"name": "sort",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/dtos.NodeTaint"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/cluster/nodes/{nodeName}": {
"get": {
"description": "Retrieve a cluster node by its name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"cluster"
],
"summary": "Get node by name",
"parameters": [
{
"type": "string",
"description": "Node name",
"name": "nodeName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dtos.NodeOutput"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/usecases": {
"get": {
"description": "List all usecases",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "List all usecases",
"parameters": [
{
"type": "string",
"description": "Filter is a JSON string containing filter criteria.\n\nExample: {\"name\":\"test\", \"projectId\":\"project-id\", \"labels\":[\"assistant\",\"ui\"]}\n\nLabels filtering uses OR logic: returns usecases with ANY of the specified labels",
"name": "filter",
"in": "query"
},
{
"type": "integer",
"format": "int",
"default": 10,
"name": "limit",
"in": "query"
},
{
"type": "integer",
"format": "int",
"default": 1,
"name": "page",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dtos.UsecasePaginatedResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
},
"post": {
"description": "Create a new usecase",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Create a new usecase",
"parameters": [
{
"description": "Usecase object that needs to be created",
"name": "usecase",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dtos.CreateUsecaseRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/dtos.UsecaseOutput"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/usecases/{usecaseID}": {
"get": {
"description": "Retrieve a usecase by its ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Get usecase by ID",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dtos.UsecaseOutput"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
},
"put": {
"description": "Update a usecase",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Update a usecase",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
},
{
"description": "Usecase object that needs to be updated",
"name": "usecase",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dtos.UpdateUsecaseRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dtos.UsecaseOutput"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
},
"delete": {
"description": "Delete a usecase if it is not active or pending (deployment status: undeployed, error)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Delete a usecase",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail422"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
},
"patch": {
"description": "Patch a usecase",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Patch a usecase",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
},
{
"description": "Usecase object that needs to be patched",
"name": "usecase",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dtos.PatchUsecaseRequest"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/usecases/{usecaseID}/deployments": {
"get": {
"description": "List all deployments of a usecase",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "List all deployments of a usecase",
"parameters": [
{
"type": "string",
"description": "ID of the usecase",
"name": "usecaseID",
"in": "path",
"required": true
},
{
"type": "string",
"description": "DeploymentFilter is a struct that contains the filter fields for the deployment\nexample: {\"status\":\"deployed\"}",
"name": "filter",
"in": "query"
},
{
"type": "integer",
"format": "int",
"default": 10,
"name": "limit",
"in": "query"
},
{
"type": "integer",
"format": "int",
"default": 1,
"name": "page",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dtos.UsecaseDeploymentPaginatedResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
},
"post": {
"description": "Triggers a usecase deployment",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Deploy a usecase",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
},
{
"description": "Usecase deployment configuration",
"name": "deploy",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dtos.DeployUsecaseRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/dtos.UsecaseDeploymentCreatedOutput"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail422"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
},
"delete": {
"description": "Triggers a usecase undeployment",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Undeploy a usecase",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail400"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail401"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail403"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail404"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail422"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/dtos.ProblemDetail500"
}
}
}
}
},
"/usecases/{usecaseID}/deployments/{deploymentID}": {
"get": {
"description": "Get a usecase deployment by ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"usecases"
],
"summary": "Get a usecase deployment by ID",
"parameters": [
{
"type": "string",
"description": "Usecase ID",
"name": "usecaseID",
"in": "path",
"required": true
},
{
"type": "string",
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aleph-alpha/refs/heads/main/openapi/aleph-alpha-pharia-os-openapi.json
This is an independent, third-party profile of PhariaOS Manager 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.