be8728b313
The Go SDK declared its module as github.com/vectorize-io/hindsight-client-go, but that repository doesn't exist. Update to github.com/vectorize-io/hindsight/hindsight-clients/go to match the actual monorepo path, enabling standard `go get` imports with directory-prefixed tags. Also enables isGoSubmodule in the OpenAPI generator config and updates all import references across tests, docs, and the client generation script. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
---
|
|
sidebar_position: 3
|
|
---
|
|
|
|
# Go Client
|
|
|
|
Official Go client for the Hindsight API, generated from the OpenAPI 3.1 spec using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator).
|
|
|
|
import CodeSnippet from '@site/src/components/CodeSnippet';
|
|
import quickstartGo from '!!raw-loader!@site/examples/api/quickstart.go';
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
go get github.com/vectorize-io/hindsight/hindsight-clients/go
|
|
```
|
|
|
|
Requires Go 1.23+.
|
|
|
|
## Quick Start
|
|
|
|
<CodeSnippet code={quickstartGo} section="quickstart-full" language="go" />
|
|
|
|
## API Structure
|
|
|
|
The Go client provides access to all Hindsight API operations through structured namespaces:
|
|
|
|
- **`client.MemoryAPI`** - Retain, recall, reflect operations
|
|
- **`client.BanksAPI`** - Bank management
|
|
- **`client.DirectivesAPI`** - Directive management
|
|
- **`client.MentalModelsAPI`** - Mental model management
|
|
- **`client.DocumentsAPI`** - Document operations
|
|
- **`client.EntitiesAPI`** - Entity operations
|
|
- **`client.OperationsAPI`** - Async operation monitoring
|
|
|
|
## Working with Nullable Fields
|
|
|
|
The Go client uses `NullableString`, `NullableTime`, and similar types for optional fields:
|
|
|
|
<CodeSnippet code={quickstartGo} section="nullable-fields" language="go" />
|
|
|
|
## Error Handling
|
|
|
|
<CodeSnippet code={quickstartGo} section="error-handling" language="go" />
|
|
|
|
## More Examples
|
|
|
|
For detailed examples of all operations, see:
|
|
- [Python SDK documentation](./python.md) - API concepts are the same
|
|
- [Node.js SDK documentation](./nodejs.md) - API concepts are the same
|
|
- [OpenAPI specification](https://hindsight.dev/openapi.json) - Complete API reference
|