POST
/
node
curl --request POST \
  --url https://aiapi.scope3.com/node \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "my-custom-node-1",
  "cloud_id": "aws",
  "cloud_instance_id": "a2-highgpu-1g",
  "managed_service_id": "aws-bedrock",
  "gpu_id": "a100_40gb",
  "gpu_count": 8,
  "cpu_count": 2,
  "idle_power_w_ex_gpu": 100,
  "average_utilization_rate": 0.8,
  "embodied_emissions_kgco2e_ex_gpu": 2500,
  "embodied_water_l_ex_gpu": 2500,
  "use_life_years": 5
}'
{
  "id": "my-custom-node-1",
  "cloud_id": "aws",
  "cloud_instance_id": "a2-highgpu-1g",
  "managed_service_id": "aws-bedrock",
  "gpu_id": "a100_40gb",
  "gpu_count": 8,
  "cpu_count": 2,
  "idle_power_w_ex_gpu": 100,
  "average_utilization_rate": 0.8,
  "embodied_emissions_kgco2e_ex_gpu": 2500,
  "embodied_water_l_ex_gpu": 2500,
  "use_life_years": 5,
  "customer_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a new node. Note on permissions:

  • cloud_instance_id and managed_service_id can only be set by admins or users who own those resources
  • Custom nodes are visible only to their owners
  • Global nodes are visible to all users
  • Admins can see and manage all nodes
​
id
string
required
Required string length: 3 - 64
Example:

"my-custom-node-1"

​
gpu_id
string
required
Example:

"a100_40gb"

​
gpu_count
integer
required
Required range: 0 <= x <= 10000
Example:

8

​
cpu_count
integer
required
Required range: 1 <= x <= 10000
Example:

2

​
cloud_id
string

Cloud ID as defined by the Scope3 API

Required string length: 1 - 64
Example:

"aws"

​
cloud_instance_id
string
Example:

"a2-highgpu-1g"

​
managed_service_id
string

Managed Service Provider ID

Required string length: 3 - 64
Example:

"aws-bedrock"

​
idle_power_w_ex_gpu
number
Required range: 0 <= x <= 10000
Example:

100

​
average_utilization_rate
number
Required range: 0 <= x <= 1
Example:

0.8

​
embodied_emissions_kgco2e_ex_gpu
number
Required range: 0 <= x <= 100000
Example:

2500

​
embodied_water_l_ex_gpu
number
Required range: 0 <= x <= 100000
Example:

2500

​
use_life_years
number
Required range: 1 <= x <= 30
Example:

5

Response

201
application/json
Node created successfully

Create a new node. Note on permissions:

  • cloud_instance_id and managed_service_id can only be set by admins or users who own those resources
  • Custom nodes are visible only to their owners
  • Global nodes are visible to all users
  • Admins can see and manage all nodes
​
id
string
required
Required string length: 3 - 64
Example:

"my-custom-node-1"

​
gpu_id
string
required
Example:

"a100_40gb"

​
gpu_count
integer
required
Required range: 0 <= x <= 10000
Example:

8

​
cpu_count
integer
required
Required range: 1 <= x <= 10000
Example:

2

​
created_at
string
required
​
updated_at
string
required
​
cloud_id
string

Cloud ID as defined by the Scope3 API

Required string length: 1 - 64
Example:

"aws"

​
cloud_instance_id
string
Example:

"a2-highgpu-1g"

​
managed_service_id
string

Managed Service Provider ID

Required string length: 3 - 64
Example:

"aws-bedrock"

​
idle_power_w_ex_gpu
number
Required range: 0 <= x <= 10000
Example:

100

​
average_utilization_rate
number
Required range: 0 <= x <= 1
Example:

0.8

​
embodied_emissions_kgco2e_ex_gpu
number
Required range: 0 <= x <= 100000
Example:

2500

​
embodied_water_l_ex_gpu
number
Required range: 0 <= x <= 100000
Example:

2500

​
use_life_years
number
Required range: 1 <= x <= 30
Example:

5

​
customer_id
integer

ID of the customer who owns this node (visible to admins only)

​
created_by
string

ID of the user who created the node (admin or owner only)