Developer-friendly & type-safe Go SDK specifically catered to leverage github.com/flowaicom/flowai-sdk-go API.
Important
This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
server: FastAPI backend for Flow Expert
To add the SDK as a dependency to your project:
go get github.com/flowaicom/flowai-sdk-gopackage main
import (
"context"
flowaisdkgo "github.com/flowaicom/flowai-sdk-go"
"log"
)
func main() {
ctx := context.Background()
s := flowaisdkgo.New()
res, err := s.Health.Get(ctx)
if err != nil {
log.Fatal(err)
}
if res.ResponseGetHealthStatus != nil {
// handle response
}
}Available methods
- List - List API Keys for the authenticated user
- Create - Generate a new API Key for the authenticated user
- Update - Update an API Key
- Revoke - Revoke an API Key
- SDKLogin - Sdk Login
- CompleteValidatorSignup - Complete Validator Signup
- VerifyValidatorAccess - Verify Validator Access
- ListMine - List My Batches
- Get - Get Batch By Id
- Delete - Delete Batch By Id
- GetTestCases - Get Batch Test Cases
- GetValidations - Get Validations For Batch
- CreateValidationTask - Create Validation Task For Batch Endpoint
- GetValidationTask - Get Validation Task For Batch Endpoint
- GetStatus - Get Batch Status Endpoint
- HandlePrefectWebhook - Prefect Webhook
- GetDetails - Get Job Details
- Cancel - Cancel Job
- GenerateBatch - Generate Batch for Job
- ListBatches - List Batches for a Job
- GenerateDataset - Generate Dataset for Job
- TriggerPipeline - Trigger Pipeline From Stages
- List - List Projects
- Create - Create Project
- Get - Get Project
- Delete - Delete Project
- Update - Update Project
- Archive - Archive Project
- GetDataset - Get Project Dataset
- ListValidators - List Project Validators
- AddValidator - Add Project Validator
- RemoveValidator - Remove Project Validator
- ListJobs - List Jobs for Project
- CreateJob - Create Job for Project
- Get - Root
- Ping - Ping Stages
- List - List Stages
- Create - Create Stages For Project
- GetDetails - Get Stage Details
- Update - Update Stage
- Delete - Delete Stage
- List - List Test Cases
- Create - Create Test Case
- Get - Get Test Case
- Update - Update Test Case
- Delete - Delete Test Case
- GetValidation - Get Single Validation From Batch
- GetMe - Read Users Me
- UpdateMe - Update User Me
- UpdateRole - Update User Role
- GetBasicInfo - Get Current User Basic Info
- List - List Validations
- Create - Create Test Case Validation
- Get - Get Validation
- Update - Update Test Case Validation
- Delete - Delete Validation
- GetStatus - Check Validation Task Status
- SubmitValidation - Submit Test Case Validation
- LoadTestCases - Load Test Cases For Validator
- UpdateValidation - Edit Test Case Validation
- Submit - Submit Validator Task
- Handle - Handle Clerk Webhook Events
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:
package main
import (
"context"
flowaisdkgo "github.com/flowaicom/flowai-sdk-go"
"github.com/flowaicom/flowai-sdk-go/retry"
"log"
"models/operations"
)
func main() {
ctx := context.Background()
s := flowaisdkgo.New()
res, err := s.Health.Get(ctx, operations.WithRetries(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}))
if err != nil {
log.Fatal(err)
}
if res.ResponseGetHealthStatus != nil {
// handle response
}
}If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:
package main
import (
"context"
flowaisdkgo "github.com/flowaicom/flowai-sdk-go"
"github.com/flowaicom/flowai-sdk-go/retry"
"log"
)
func main() {
ctx := context.Background()
s := flowaisdkgo.New(
flowaisdkgo.WithRetryConfig(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
)
res, err := s.Health.Get(ctx)
if err != nil {
log.Fatal(err)
}
if res.ResponseGetHealthStatus != nil {
// handle response
}
}Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.
By Default, an API error will return apierrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.
For example, the Handle function may return the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| apierrors.HTTPValidationError | 422 | application/json |
| apierrors.APIError | 4XX, 5XX | */* |
package main
import (
"context"
"errors"
flowaisdkgo "github.com/flowaicom/flowai-sdk-go"
"github.com/flowaicom/flowai-sdk-go/models/apierrors"
"log"
)
func main() {
ctx := context.Background()
s := flowaisdkgo.New()
res, err := s.Webhooks.Handle(ctx, nil, nil, nil)
if err != nil {
var e *apierrors.HTTPValidationError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *apierrors.APIError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}The default server can be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:
package main
import (
"context"
flowaisdkgo "github.com/flowaicom/flowai-sdk-go"
"log"
)
func main() {
ctx := context.Background()
s := flowaisdkgo.New(
flowaisdkgo.WithServerURL("http://localhost:8000"),
)
res, err := s.Health.Get(ctx)
if err != nil {
log.Fatal(err)
}
if res.ResponseGetHealthStatus != nil {
// handle response
}
}The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.