Search
⌃K

Resources (beta)

Control the state and settings of your resources.

List resources

get
https://beta-api.forefront.ai
/api/v1/{team_id}/resources/list
List resources
List the resources for your team. Your Team ID can be found here.
Parameters
Header
Authorization*
String
Bearer <YOUR_PLATFORM_KEY>
Platform keys can be found in Settings -> API Keys
Responses
200: OK
Resources successfully returned.

Update resource status

post
https://beta-api.forefront.ai
/api/v1/{team_id}/resources/{resource_id}/active
Update resource status
Turn a resource on or off. Your Team ID and Resource ID can be found here.
Parameters
Header
Authorization*
String
Bearer <YOUR_PLATFORM_KEY>
Platform keys can be found in Settings -> API Keys
Body
active*
Boolean
Set active to True to turn the resource on.
Set active to False to turn the resource off.
Responses
200: OK
Successfully updated the resource status.

Update scaling settings

post
https://beta-api.forefront.ai
/api/v1/{team_id}/resources/{resource_id}/scaling
Update scaling status
Update the scaling settings for a resource. Your Team ID and Resource ID can be found here. Learn more about scaling settings.
Parameters
Header
Authorization*
String
Bearer <YOUR_PLATFORM_KEY>
Platform keys can be found in Settings -> API Keys
Body
autoscalingEnabled
Boolean
Set autoscalingEnabled to True to turn autoscaling on.
Set autoscalingEnabled to False to turn autoscaling off.
minScale
Integer
The minimum number of GPUs that can be live.
If autoscalingEnabled = False, this is used to set a fixed number of live GPUs.
maxScale
Integer
The maximum number of GPUs that can be live.
initialScale
Integer
The number of GPUs to turn on when the resource is turned on.
Can be used to skip the warm-up phase when processing large volumes.
Responses
200: OK
Last modified 1mo ago