Endpoints

Instance List

GEThttps://api.oneinfer.ai/v1/developer/:developerId/get-instances?provider_name=all

List all instances associated with your developer account for a specific provider.

Query Parameters

provider_name
string (required)Filter instances by provider. Use all to retrieve instances from all providers.

Example Usage

curl --request GET \
  --url '${BASE_URL}/v1/developer/<YOUR_DEVELOPER_ID>/get-instances?provider_name=all' \
  --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

Example Response

[
  {
    "instance_id": "inst_987654321",
    "instance_name": "my-gpu-instance",
    "status": "RUNNING",
    "ip_address": "123.45.67.89",
    "ssh_command": "ssh root@123.45.67.89",
    "gpu_name": "NVIDIA A100 80GB",
    "gpu_num": 1
  }
]

Error Status Codes

CodeStatusDescription
200OKInstances listed successfully.
401UnauthorizedMissing or invalid Authorization header / Bearer token.
500Internal Server ErrorUnexpected error fetching instances.

Response

202 - application/json