29 KiB
\GuideAPI
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| DeleteGuideCurriculum | Delete /v1/guide/curriculum | Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture. |
| GetGuide | Get /v1/guide | Returns the caller org's launch journey: the active curriculum's version and title, every step with its state, whether it is available, what blocks it and whether the Business AI can run it, the done/total/percent progress with the next step to take, and the org's analytics funnel folded in. |
| GetGuideActions | Get /v1/guide/actions | Returns the caller org's Business AI action ledger, most recent first: every "do it for me" tool call, the arguments it ran with, its result and whether it succeeded. |
| GetGuideAnalytics | Get /v1/guide/analytics | Returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it. |
| GetGuideCurriculum | Get /v1/guide/curriculum | Returns the journey the caller's org is actually running, and whether it comes from the org's OWN override (custom) or from the platform default — the brand blueprint, else the embedded fixture. |
| GetGuideProfile | Get /v1/guide/profile | Returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics. |
| GetGuideStrategies | Get /v1/guide/strategies | Returns the ENABLED tactics corpus for the caller's org: the tactics library narrowed by the explicit category/workload filters AND by the org's OBSERVED growth stage and capability signals (a tactic's tags are preconditions, so it surfaces only once the org can act on it). |
| GetGuideSuggest | Get /v1/guide/suggest | Returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by how much downstream work each unblocks, each with the grounded reason it is a good next move and whether the Business AI can run it, plus the org's funnel and the GTM recommendations derived from it. |
| PostGuideChat | Post /v1/guide/chat | Answers a founder's question about their launch journey as the Business AI coach: it grounds the reply in the org's REAL progress, its ranked available quests and its analytics funnel, and returns those candidate quests alongside so the caller can act on one. |
| PostGuideStepsByIdDo | Post /v1/guide/steps/{id}/do | Have the Business AI actually do the step for you |
| PostGuideStepsByIdDone | Post /v1/guide/steps/{id}/done | Marks one step of the caller org's journey complete and returns the refreshed journey. |
| PostGuideStepsByIdReset | Post /v1/guide/steps/{id}/reset | Returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and returns the refreshed journey. |
| PostGuideStepsByIdSkip | Post /v1/guide/steps/{id}/skip | Marks one step of the caller org's journey skipped and returns the refreshed journey. |
| PostGuideStepsByIdStart | Post /v1/guide/steps/{id}/start | Marks one step of the caller org's journey in progress and returns the refreshed journey. |
| PutGuideCurriculum | Put /v1/guide/curriculum | Replace your org's journey with a curriculum you author |
DeleteGuideCurriculum
GuideCurriculumView DeleteGuideCurriculum(ctx).Execute()
Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.
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.GuideAPI.DeleteGuideCurriculum(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.DeleteGuideCurriculum``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteGuideCurriculum`: GuideCurriculumView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.DeleteGuideCurriculum`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiDeleteGuideCurriculumRequest 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]
GetGuide
GuideOverviewView GetGuide(ctx).Execute()
Returns the caller org's launch journey: the active curriculum's version and title, every step with its state, whether it is available, what blocks it and whether the Business AI can run it, the done/total/percent progress with the next step to take, and the org's analytics funnel folded in.
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.GuideAPI.GetGuide(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuide``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuide`: GuideOverviewView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuide`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideRequest 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]
GetGuideActions
GuideActionsView GetGuideActions(ctx).Execute()
Returns the caller org's Business AI action ledger, most recent first: every "do it for me" tool call, the arguments it ran with, its result and whether it succeeded.
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.GuideAPI.GetGuideActions(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuideActions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuideActions`: GuideActionsView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuideActions`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideActionsRequest 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]
GetGuideAnalytics
GuideAnalyticsView GetGuideAnalytics(ctx).Execute()
Returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it.
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.GuideAPI.GetGuideAnalytics(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuideAnalytics``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuideAnalytics`: GuideAnalyticsView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuideAnalytics`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideAnalyticsRequest 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]
GetGuideCurriculum
GuideCurriculumView GetGuideCurriculum(ctx).Execute()
Returns the journey the caller's org is actually running, and whether it comes from the org's OWN override (custom) or from the platform default — the brand blueprint, else the embedded fixture.
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.GuideAPI.GetGuideCurriculum(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuideCurriculum``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuideCurriculum`: GuideCurriculumView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuideCurriculum`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideCurriculumRequest 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]
GetGuideProfile
GuideProfileResponse GetGuideProfile(ctx).Execute()
Returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics.
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.GuideAPI.GetGuideProfile(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuideProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuideProfile`: GuideProfileResponse
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuideProfile`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideProfileRequest 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]
GetGuideStrategies
GuideCorpusView GetGuideStrategies(ctx).Category(category).Stage(stage).Workload(workload).Execute()
Returns the ENABLED tactics corpus for the caller's org: the tactics library narrowed by the explicit category/workload filters AND by the org's OBSERVED growth stage and capability signals (a tactic's tags are preconditions, so it surfaces only once the org can act on it).
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
category := "viral-coefficient" // string | Category filters to tactics in exactly this category. (optional)
stage := "scaling" // string | Stage previews the corpus at a chosen growth stage (research|formed|launched|activated|scaling), overriding the org's observed one. An unknown value is ignored and the observed stage stands. (optional)
workload := "workload_example" // string | Workload filters to tactics with exactly this workload. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.GuideAPI.GetGuideStrategies(context.Background()).Category(category).Stage(stage).Workload(workload).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuideStrategies``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuideStrategies`: GuideCorpusView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuideStrategies`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideStrategiesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| category | string | Category filters to tactics in exactly this category. | |
| stage | string | Stage previews the corpus at a chosen growth stage (research | formed |
| workload | string | Workload filters to tactics with exactly this workload. |
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]
GetGuideSuggest
GuideSuggestResponse GetGuideSuggest(ctx).Execute()
Returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by how much downstream work each unblocks, each with the grounded reason it is a good next move and whether the Business AI can run it, plus the org's funnel and the GTM recommendations derived from it.
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.GuideAPI.GetGuideSuggest(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.GetGuideSuggest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGuideSuggest`: GuideSuggestResponse
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.GetGuideSuggest`: %v\n", resp)
}
Path Parameters
This endpoint does not need any parameter.
Other Parameters
Other parameters are passed through a pointer to a apiGetGuideSuggestRequest 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]
PostGuideChat
GuideChatResponse PostGuideChat(ctx).GuideChatRequest(guideChatRequest).Execute()
Answers a founder's question about their launch journey as the Business AI coach: it grounds the reply in the org's REAL progress, its ranked available quests and its analytics funnel, and returns those candidate quests alongside so the caller can act on one.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
guideChatRequest := *openapiclient.NewGuideChatRequest() // GuideChatRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.GuideAPI.PostGuideChat(context.Background()).GuideChatRequest(guideChatRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PostGuideChat``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostGuideChat`: GuideChatResponse
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.PostGuideChat`: %v\n", resp)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiPostGuideChatRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| guideChatRequest | GuideChatRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/problem+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PostGuideStepsByIdDo
PostGuideStepsByIdDo(ctx, id).Execute()
Have the Business AI actually do the step for you
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.GuideAPI.PostGuideStepsByIdDo(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PostGuideStepsByIdDo``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
Other Parameters
Other parameters are passed through a pointer to a apiPostGuideStepsByIdDoRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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]
PostGuideStepsByIdDone
GuideOverviewView PostGuideStepsByIdDone(ctx, id).Execute()
Marks one step of the caller org's journey complete and returns the refreshed journey.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.GuideAPI.PostGuideStepsByIdDone(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PostGuideStepsByIdDone``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostGuideStepsByIdDone`: GuideOverviewView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.PostGuideStepsByIdDone`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the step's id, as it appears in the journey (e.g. "gsuite"). |
Other Parameters
Other parameters are passed through a pointer to a apiPostGuideStepsByIdDoneRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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]
PostGuideStepsByIdReset
GuideOverviewView PostGuideStepsByIdReset(ctx, id).Execute()
Returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and returns the refreshed journey.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.GuideAPI.PostGuideStepsByIdReset(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PostGuideStepsByIdReset``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostGuideStepsByIdReset`: GuideOverviewView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.PostGuideStepsByIdReset`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the step's id, as it appears in the journey (e.g. "gsuite"). |
Other Parameters
Other parameters are passed through a pointer to a apiPostGuideStepsByIdResetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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]
PostGuideStepsByIdSkip
GuideOverviewView PostGuideStepsByIdSkip(ctx, id).Execute()
Marks one step of the caller org's journey skipped and returns the refreshed journey.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.GuideAPI.PostGuideStepsByIdSkip(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PostGuideStepsByIdSkip``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostGuideStepsByIdSkip`: GuideOverviewView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.PostGuideStepsByIdSkip`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the step's id, as it appears in the journey (e.g. "gsuite"). |
Other Parameters
Other parameters are passed through a pointer to a apiPostGuideStepsByIdSkipRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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]
PostGuideStepsByIdStart
GuideOverviewView PostGuideStepsByIdStart(ctx, id).Execute()
Marks one step of the caller org's journey in progress and returns the refreshed journey.
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/hanzoai/go-sdk/v8"
)
func main() {
id := "id_example" // string | ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.GuideAPI.PostGuideStepsByIdStart(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PostGuideStepsByIdStart``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PostGuideStepsByIdStart`: GuideOverviewView
fmt.Fprintf(os.Stdout, "Response from `GuideAPI.PostGuideStepsByIdStart`: %v\n", resp)
}
Path Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID is the step's id, as it appears in the journey (e.g. "gsuite"). |
Other Parameters
Other parameters are passed through a pointer to a apiPostGuideStepsByIdStartRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
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]
PutGuideCurriculum
PutGuideCurriculum(ctx).Execute()
Replace your org's journey with a curriculum you author
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.GuideAPI.PutGuideCurriculum(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `GuideAPI.PutGuideCurriculum``: %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 apiPutGuideCurriculumRequest 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]