4.5 KiB
\BlueprintAPI
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| GetBlueprint | Get /v1/blueprint | Returns every deployable blueprint with its service count and estimated monthly compute cost. |
| GetBlueprintHealth | Get /v1/blueprint/health | Reports blueprint liveness and echoes the compute rate card in force. |
| GetBlueprintSbom | Get /v1/blueprint/sbom | A blueprint's bill of images and what running it costs |
GetBlueprint
BlueprintBlueprintIndex GetBlueprint(ctx).Execute()
Returns every deployable blueprint with its service count and estimated monthly compute cost.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BlueprintAPI.GetBlueprint(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BlueprintAPI.GetBlueprint``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetBlueprint`: BlueprintBlueprintIndex
fmt.Fprintf(os.Stdout, "Response from `BlueprintAPI.GetBlueprint`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetBlueprintRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetBlueprintHealth
BlueprintBlueprintHealth GetBlueprintHealth(ctx).Execute()
Reports blueprint liveness and echoes the compute rate card in force.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.BlueprintAPI.GetBlueprintHealth(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BlueprintAPI.GetBlueprintHealth``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetBlueprintHealth`: BlueprintBlueprintHealth
fmt.Fprintf(os.Stdout, "Response from `BlueprintAPI.GetBlueprintHealth`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetBlueprintHealthRequest struct via the builder pattern
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetBlueprintSbom
GetBlueprintSbom(ctx).Execute()
A blueprint's bill of images and what running it costs
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.BlueprintAPI.GetBlueprintSbom(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `BlueprintAPI.GetBlueprintSbom``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetBlueprintSbomRequest struct via the builder pattern
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]