Skip to content

Latest commit

 

History

History
649 lines (419 loc) · 20.1 KB

File metadata and controls

649 lines (419 loc) · 20.1 KB

\AgenticWorkflowsAPI

All URIs are relative to https://api.qovery.com

Method HTTP request Description
CancelAgenticWorkflowDeployment Post /agenticWorkflow/{agenticWorkflowId}/cancelDeployment Cancel agentic workflow deployment
CreateAgenticWorkflow Post /environment/{environmentId}/agenticWorkflow Create an agentic workflow
DeleteAgenticWorkflow Delete /agenticWorkflow/{agenticWorkflowId} Delete an agentic workflow
DeployAgenticWorkflow Post /agenticWorkflow/{agenticWorkflowId}/deploy Deploy an agentic workflow
EditAgenticWorkflow Put /agenticWorkflow/{agenticWorkflowId} Edit an agentic workflow
GetAgenticWorkflow Get /agenticWorkflow/{agenticWorkflowId} Get an agentic workflow
ListAgenticWorkflowDeploymentHistoryV2 Get /agenticWorkflow/{agenticWorkflowId}/deploymentHistoryV2 List agentic workflow deployments
ListAgenticWorkflowRunHistory Get /agenticWorkflow/{agenticWorkflowId}/runHistory List agentic workflow runs
ListAgenticWorkflows Get /environment/{environmentId}/agenticWorkflow List agentic workflows

CancelAgenticWorkflowDeployment

CancelAgenticWorkflowDeployment(ctx, agenticWorkflowId).CancelAgenticWorkflowDeploymentRequest(cancelAgenticWorkflowDeploymentRequest).Execute()

Cancel agentic workflow deployment

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	cancelAgenticWorkflowDeploymentRequest := *openapiclient.NewCancelAgenticWorkflowDeploymentRequest() // CancelAgenticWorkflowDeploymentRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AgenticWorkflowsAPI.CancelAgenticWorkflowDeployment(context.Background(), agenticWorkflowId).CancelAgenticWorkflowDeploymentRequest(cancelAgenticWorkflowDeploymentRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.CancelAgenticWorkflowDeployment``: %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.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiCancelAgenticWorkflowDeploymentRequest struct via the builder pattern

Name Type Description Notes

cancelAgenticWorkflowDeploymentRequest | CancelAgenticWorkflowDeploymentRequest | |

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAgenticWorkflow

AgenticWorkflowResponse CreateAgenticWorkflow(ctx, environmentId).AgenticWorkflowRequest(agenticWorkflowRequest).Execute()

Create an agentic workflow

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID
	agenticWorkflowRequest := *openapiclient.NewAgenticWorkflowRequest("Name_example") // AgenticWorkflowRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.CreateAgenticWorkflow(context.Background(), environmentId).AgenticWorkflowRequest(agenticWorkflowRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.CreateAgenticWorkflow``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateAgenticWorkflow`: AgenticWorkflowResponse
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.CreateAgenticWorkflow`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId string Environment ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateAgenticWorkflowRequest struct via the builder pattern

Name Type Description Notes

agenticWorkflowRequest | AgenticWorkflowRequest | |

Return type

AgenticWorkflowResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAgenticWorkflow

Status DeleteAgenticWorkflow(ctx, agenticWorkflowId).Execute()

Delete an agentic workflow

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.DeleteAgenticWorkflow(context.Background(), agenticWorkflowId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.DeleteAgenticWorkflow``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteAgenticWorkflow`: Status
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.DeleteAgenticWorkflow`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAgenticWorkflowRequest struct via the builder pattern

Name Type Description Notes

Return type

Status

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeployAgenticWorkflow

Status DeployAgenticWorkflow(ctx, agenticWorkflowId).Execute()

Deploy an agentic workflow

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.DeployAgenticWorkflow(context.Background(), agenticWorkflowId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.DeployAgenticWorkflow``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeployAgenticWorkflow`: Status
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.DeployAgenticWorkflow`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiDeployAgenticWorkflowRequest struct via the builder pattern

Name Type Description Notes

Return type

Status

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditAgenticWorkflow

AgenticWorkflowResponse EditAgenticWorkflow(ctx, agenticWorkflowId).AgenticWorkflowRequest(agenticWorkflowRequest).Execute()

Edit an agentic workflow

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	agenticWorkflowRequest := *openapiclient.NewAgenticWorkflowRequest("Name_example") // AgenticWorkflowRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.EditAgenticWorkflow(context.Background(), agenticWorkflowId).AgenticWorkflowRequest(agenticWorkflowRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.EditAgenticWorkflow``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditAgenticWorkflow`: AgenticWorkflowResponse
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.EditAgenticWorkflow`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiEditAgenticWorkflowRequest struct via the builder pattern

Name Type Description Notes

agenticWorkflowRequest | AgenticWorkflowRequest | |

Return type

AgenticWorkflowResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgenticWorkflow

AgenticWorkflowResponse GetAgenticWorkflow(ctx, agenticWorkflowId).Execute()

Get an agentic workflow

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.GetAgenticWorkflow(context.Background(), agenticWorkflowId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.GetAgenticWorkflow``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAgenticWorkflow`: AgenticWorkflowResponse
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.GetAgenticWorkflow`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiGetAgenticWorkflowRequest struct via the builder pattern

Name Type Description Notes

Return type

AgenticWorkflowResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAgenticWorkflowDeploymentHistoryV2

DeploymentHistoryServicePaginatedResponseListV2 ListAgenticWorkflowDeploymentHistoryV2(ctx, agenticWorkflowId).PageSize(pageSize).Execute()

List agentic workflow deployments

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pageSize := float32(8.14) // float32 | The number of deployments to return in the current page (optional) (default to 20)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.ListAgenticWorkflowDeploymentHistoryV2(context.Background(), agenticWorkflowId).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.ListAgenticWorkflowDeploymentHistoryV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListAgenticWorkflowDeploymentHistoryV2`: DeploymentHistoryServicePaginatedResponseListV2
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.ListAgenticWorkflowDeploymentHistoryV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiListAgenticWorkflowDeploymentHistoryV2Request struct via the builder pattern

Name Type Description Notes

pageSize | float32 | The number of deployments to return in the current page | [default to 20]

Return type

DeploymentHistoryServicePaginatedResponseListV2

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAgenticWorkflowRunHistory

AgenticWorkflowRunPaginatedResponseList ListAgenticWorkflowRunHistory(ctx, agenticWorkflowId).Page(page).PageSize(pageSize).Execute()

List agentic workflow runs

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	agenticWorkflowId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	page := int32(56) // int32 | Page number, starting at 1. Increment this value to retrieve subsequent pages of run history, keeping pageSize unchanged. (optional) (default to 1)
	pageSize := int32(56) // int32 | The number of runs to return in the current page. Must be between 1 and 100. (optional) (default to 20)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.ListAgenticWorkflowRunHistory(context.Background(), agenticWorkflowId).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.ListAgenticWorkflowRunHistory``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListAgenticWorkflowRunHistory`: AgenticWorkflowRunPaginatedResponseList
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.ListAgenticWorkflowRunHistory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
agenticWorkflowId string

Other Parameters

Other parameters are passed through a pointer to a apiListAgenticWorkflowRunHistoryRequest struct via the builder pattern

Name Type Description Notes

page | int32 | Page number, starting at 1. Increment this value to retrieve subsequent pages of run history, keeping pageSize unchanged. | [default to 1] pageSize | int32 | The number of runs to return in the current page. Must be between 1 and 100. | [default to 20]

Return type

AgenticWorkflowRunPaginatedResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAgenticWorkflows

AgenticWorkflowResponseList ListAgenticWorkflows(ctx, environmentId).Execute()

List agentic workflows

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AgenticWorkflowsAPI.ListAgenticWorkflows(context.Background(), environmentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgenticWorkflowsAPI.ListAgenticWorkflows``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListAgenticWorkflows`: AgenticWorkflowResponseList
	fmt.Fprintf(os.Stdout, "Response from `AgenticWorkflowsAPI.ListAgenticWorkflows`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId string Environment ID

Other Parameters

Other parameters are passed through a pointer to a apiListAgenticWorkflowsRequest struct via the builder pattern

Name Type Description Notes

Return type

AgenticWorkflowResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]