external-api (1.0.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://api-docs.inference.ai/_mock/openapi/

Prod Env

https://console-api.inference.ai/

Server Instances

Operations

Create

Request

Headers

Api-Keystringrequired

Example: {{Api-Key}}

Content-Typestringrequired

Example: application/json

Bodyapplication/json

instance_namestringrequired

template_idintegerrequired

allow_sshbooleanrequired

extra_portsArray of integersrequired

curl -i -X POST \
  https://api-docs.inference.ai/_mock/openapi/external/api/v1/createServerInstance \
  -H 'Api-Key: {{Api-Key}}' \
  -H 'Content-Type: application/json' \
  -d '{
    "instance_name": "lifeng-jupyter-1211",
    "template_id": 3008,
    "allow_ssh": false,
    "extra_ports": []
  }'

Responses

Bodyapplication/json

statusstringrequired

dataobjectrequired

data.instance_idintegerrequired

data.instance_namestringrequired

data.org_idintegerrequired

data.user_idintegerrequired

data.Usernullrequired

data.UserOrganizationnullrequired

data.machine_imagestringrequired

data.support_sshbooleanrequired

data.service_portsArray of objectsrequired

data.service_ports[].portinteger

data.service_ports[].protocolstring

data.service_ports[].namestring

data.service_urlsArray of objectsrequired

data.service_urls[].urlstringrequired

data.service_urls[].namestringrequired

data.service_urls[].mapped_portintegerrequired

data.cpu_request_countintegerrequired

data.cpu_limit_countintegerrequired

data.ram_request_gbintegerrequired

data.ram_limit_gbintegerrequired

data.gpu_request_countintegerrequired

data.gpu_request_ratiointegerrequired

data.gpu_request_gmemintegerrequired

data.ephemeral_storage_request_gbintegerrequired

data.ephemeral_storage_limit_gbintegerrequired

data.shm_limit_gbintegerrequired

data.init_commandsobjectrequired

data.init_commands.commandArray of stringsrequired

data.metadataobjectrequired

data.metadata.extraobjectrequired

data.metadata.extra.mount_pathstringrequired

data.metadata.extra.passwordstringrequired

data.metadata.extra.tokenstringrequired

data.metadata.ingressArray of stringsrequired

data.metadata.serviceArray of stringsrequired

data.metadata.sshnullrequired

data.metadata.versionintegerrequired

data.created_atstringrequired

data.started_atstringrequired

data.destroyed_atnullrequired

data.StorageVolumenullrequired

data.template_idintegerrequired

data.ServerTemplatenullrequired

data.is_deletedbooleanrequired

data.k8s_namespacestringrequired

data.k8s_deployment_namestringrequired

data.k8s_deployment_uidstringrequired

data.app_namestringrequired

data.spend_updated_atnullrequired

Response

application/json

{
  "status": "success",
  "data": {
    "instance_id": 5020,
    "instance_name": "lifeng-jupyter-1211",
    "org_id": 1000,
    "user_id": 1000,
    "User": null,
    "UserOrganization": null,
    "machine_image": "harbor.service-inference.ai/library/jupyter-torch",
    "support_ssh": false,
    "service_ports": [ … ],
    "service_urls": [ … ],
    "cpu_request_count": 2,
    "cpu_limit_count": 4,
    "ram_request_gb": 8,
    "ram_limit_gb": 16,
    "gpu_request_count": 1,
    "gpu_request_ratio": 20,
    "gpu_request_gmem": 8,
    "ephemeral_storage_request_gb": 0,
    "ephemeral_storage_limit_gb": 0,
    "shm_limit_gb": 1,
    "init_commands": { … },
    "metadata": { … },
    "created_at": "2025-02-07T06:34:47.761768Z",
    "started_at": "2025-02-07T06:34:47.761768Z",
    "destroyed_at": null,
    "StorageVolume": null,
    "template_id": 3008,
    "ServerTemplate": null,
    "is_deleted": false,
    "k8s_namespace": "local",
    "k8s_deployment_name": "deployment-1000-1000-1738910086719",
    "k8s_deployment_uid": "6521a545-b5db-40d3-a051-713918a85c09",
    "app_name": "server-1738910086719",
    "spend_updated_at": null
  }
}

list

Request

Query

page_sizeinteger

Example: page_size=10

page_numberinteger

Example: page_number=1

Headers

Api-Keystringrequired

Example: {{Api-Key}}

Content-Typestringrequired

Example: application/json

curl -i -X GET \
  'https://api-docs.inference.ai/_mock/openapi/external/api/v1/listServerInstances?page_number=1&page_size=10' \
  -H 'Api-Key: {{Api-Key}}' \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/json

statusstringrequired

dataobjectrequired

data.instancesArray of objectsrequired

data.instances[].instance_idinteger

data.instances[].instance_namestring

data.instances[].org_idinteger

data.instances[].user_metadatanull

data.instances[].user_idinteger

data.instances[].template_idinteger

data.instances[].template_namestring

data.instances[].created_atstring

data.instances[].statusstring

data.instances[].started_atstring

data.instances[].emailstring

data.instances[].destroyed_atnull

data.totalintegerrequired

Response

application/json

{
  "status": "success",
  "data": {
    "instances": [ … ],
    "total": 1
  }
}

delete

Request

Headers

Api-Keystringrequired

Example: {{Api-Key}}

Content-Typestringrequired

Example: application/json

Bodyapplication/json

instance_idintegerrequired

curl -i -X POST \
  https://api-docs.inference.ai/_mock/openapi/external/api/v1/deleteServerInstance \
  -H 'Api-Key: {{Api-Key}}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 5017
  }'

Responses

Bodyapplication/json

statusstringrequired

Response

application/json

{
  "status": "success"
}

external-api (1.0.0)

Server Instances

Create

Request

Responses

Was this helpful?

list

Request

Responses

Was this helpful?

delete

Request

Responses

Was this helpful?