AgentDBDocs

AgentDB with Go

Use AgentDB as the database of your Go app. This page shows every call you need, with net/http and encoding/json from the standard library. No modules beyond the standard library.

You can copy each block into your own code. Together they form one program that our tests run.

This page is tested in CI: its code runs against a fresh AgentDB on every change.

Server-side only. Create one http.Client with a timeout and reuse it. Call AgentDB from your HTTP handlers; never send the key to a browser.

#Before you start

  • Go 1.22 or newer.
  • A workspace with the example schema: contact, company and works_at.
  • Three environment variables on your server: AGENTDB_URL, AGENTDB_API_KEY and AGENTDB_WORKSPACE. See Environment variables.

#Connect

Read the settings from the environment. The key never appears in the code.

Goexamples/languages/go/main.go
var (
	baseURL   = strings.TrimRight(cmp.Or(os.Getenv("AGENTDB_URL"), "https://app.agentdb.link"), "/")
	apiKey    = os.Getenv("AGENTDB_API_KEY")   // a server-side secret: never in browser code
	workspace = os.Getenv("AGENTDB_WORKSPACE") // ws_...
	apiURL    = baseURL + "/v1/workspaces/" + workspace
)

func init() {
	if apiKey == "" || workspace == "" {
		log.Fatal("Set AGENTDB_API_KEY and AGENTDB_WORKSPACE")
	}
}

Every call goes through one small helper. It sends the key in the Authorization: Bearer header, turns AgentDB errors into one error type, and retries when that is safe.

Goexamples/languages/go/main.go
// M is a JSON object.
type M = map[string]any

// AgentDBError is an AgentDB error: HTTP status plus the error envelope {code, message, retryable, details}.
type AgentDBError struct {
	Status    int
	Code      string `json:"code"`
	Message   string `json:"message"`
	Retryable bool   `json:"retryable"`
	Details   M      `json:"details"`
}

func (e *AgentDBError) Error() string { return fmt.Sprintf("%d %s: %s", e.Status, e.Code, e.Message) }

// Request holds the optional parts of a call.
type Request struct {
	JSON           any    // sent as application/json
	Body           []byte // sent as application/octet-stream
	IdempotencyKey string
}

// send makes one API call. It sends the key in the Authorization header. It retries 429 and 503
// with Retry-After (or exponential backoff), and network errors when the call is safe to repeat
// (GET, or a write with an Idempotency-Key). It returns the raw response; close its Body.
func send(method, path string, req Request) (*http.Response, error) {
	safeToRepeat := method == "GET" || req.IdempotencyKey != ""
	for attempt := 0; ; attempt++ {
		backoff := time.Duration(500<<attempt) * time.Millisecond
		var body io.Reader
		contentType := ""
		if req.JSON != nil {
			b, err := json.Marshal(req.JSON)
			if err != nil {
				return nil, err
			}
			body, contentType = bytes.NewReader(b), "application/json"
		} else if req.Body != nil {
			body, contentType = bytes.NewReader(req.Body), "application/octet-stream"
		}
		httpReq, err := http.NewRequest(method, apiURL+path, body)
		if err != nil {
			return nil, err
		}
		httpReq.Header.Set("Authorization", "Bearer "+apiKey)
		if contentType != "" {
			httpReq.Header.Set("Content-Type", contentType)
		}
		if req.IdempotencyKey != "" {
			httpReq.Header.Set("Idempotency-Key", req.IdempotencyKey)
		}
		res, err := http.DefaultClient.Do(httpReq)
		if err != nil {
			if safeToRepeat && attempt < 4 {
				time.Sleep(backoff)
				continue
			}
			return nil, err
		}
		if (res.StatusCode == 429 || res.StatusCode == 503) && attempt < 4 {
			res.Body.Close()
			wait := backoff + time.Duration(mathrand.IntN(250))*time.Millisecond
			if seconds, _ := strconv.Atoi(res.Header.Get("Retry-After")); seconds > 0 {
				wait = time.Duration(seconds) * time.Second
			}
			time.Sleep(wait)
			continue
		}
		if res.StatusCode < 200 || res.StatusCode > 299 {
			defer res.Body.Close()
			var envelope struct {
				Error AgentDBError `json:"error"`
			}
			_ = json.NewDecoder(res.Body).Decode(&envelope) // no envelope: keep the defaults
			apiErr := envelope.Error
			apiErr.Status = res.StatusCode
			if apiErr.Code == "" {
				apiErr.Code = "HTTP_ERROR"
			}
			return nil, &apiErr
		}
		return res, nil
	}
}

// call makes one API call and returns the "data" part of the answer.
func call(method, path string, req Request) (M, error) {
	res, err := send(method, path, req)
	if err != nil {
		return nil, err
	}
	defer res.Body.Close()
	var envelope struct {
		Data M `json:"data"`
	}
	err = json.NewDecoder(res.Body).Decode(&envelope)
	return envelope.Data, err
}

Check the connection by reading the schema:

Goexamples/languages/go/main.go
	schema, err := call("GET", "/object-types", Request{})
	if err != nil {
		log.Fatal(err)
	}
	var names []string
	for _, o := range schema["objects"].([]any) {
		names = append(names, o.(M)["name"].(string))
	}
	fmt.Println("Objects:", strings.Join(names, ", "))

#Create a record

Send the object name and the field values. AgentDB checks each value against its field type. The answer holds the new record with its id and version 1.

Goexamples/languages/go/main.go
	ada, err := call("POST", "/records", Request{
		JSON:           M{"object": "contact", "data": M{"name": "Ada Lovelace", "email": "ada-" + run + "@example.com", "score": 72}},
		IdempotencyKey: randomUUID(), // safe to retry: the same key never writes twice
	})
	if err != nil {
		log.Fatal(err)
	}
	adaID := ada["id"].(string)
	fmt.Println("Created", adaID, "version", ada["version"])

The Idempotency-Key header makes a retry safe. See Idempotency keys.

#Read a record

Goexamples/languages/go/main.go
	record, err := call("GET", "/records/"+adaID, Request{})
	if err != nil {
		log.Fatal(err)
	}
	data := record["data"].(M)
	fmt.Println(data["name"], data["email"], "version", record["version"])

#Update a record

An update names the version you read. If someone changed the record since then, AgentDB refuses with VERSION_CONFLICT (HTTP 409) and writes nothing. Read it again, apply your change, and try again:

Goexamples/languages/go/main.go
	// updateRecord reads, changes and writes with the current version.
	// On VERSION_CONFLICT it reads again and retries.
	updateRecord := func(id string, change func(data M) M) (M, error) {
		for i := 1; ; i++ {
			current, err := call("GET", "/records/"+id, Request{})
			if err != nil {
				return nil, err
			}
			updated, err := call("PATCH", "/records/"+id, Request{JSON: M{"version": current["version"], "data": change(current["data"].(M))}})
			var apiErr *AgentDBError
			if errors.As(err, &apiErr) && apiErr.Code == "VERSION_CONFLICT" && i < 3 {
				continue
			}
			return updated, err
		}
	}

	updated, err := updateRecord(adaID, func(data M) M { return M{"score": data["score"].(float64) + 10} })
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Score", updated["data"].(M)["score"], "version", updated["version"])

This is what the conflict looks like:

Goexamples/languages/go/main.go
	_, err = call("PATCH", "/records/"+adaID, Request{JSON: M{"version": 1, "data": M{"score": 0}}}) // stale version
	var conflict *AgentDBError
	if errors.As(err, &conflict) && conflict.Code == "VERSION_CONFLICT" {
		fmt.Println("Conflict: the record is now at version", conflict.Details["current_version"])
	} else if err != nil {
		log.Fatal(err)
	}

#Query with filters, sort and pages

A query takes an object, a where filter, a sort and a limit (at most 200). Every condition in all must match. Use the in operator for "one of several values". Operators: eq, neq, in, lt, lte, gt, gte, is_null, is_not_null.

When more records match, the answer holds a next_cursor. Send it as cursor with the same query to get the next page. A next_cursor of null means you have them all.

Goexamples/languages/go/main.go
	// queryAll returns every record that matches, page by page (limit up to 200; follow next_cursor).
	queryAll := func(object string, where M, sort []M, pageSize int) ([]M, error) {
		var out []M
		cursor := ""
		for {
			query := M{"object": object, "where": where, "sort": sort, "limit": pageSize}
			if cursor != "" {
				query["cursor"] = cursor
			}
			page, err := call("POST", "/query", Request{JSON: query})
			if err != nil {
				return nil, err
			}
			for _, r := range page["records"].([]any) {
				out = append(out, r.(M))
			}
			cursor, _ = page["next_cursor"].(string) // null on the last page
			if cursor == "" {
				return out, nil
			}
		}
	}

	good, err := queryAll(
		"contact",
		M{"all": []M{{"field": "score", "op": "gte", "value": 70}, {"field": "email", "op": "neq", "value": "nobody@example.com"}}},
		[]M{{"field": "score", "order": "desc"}},
		2,
	)
	if err != nil {
		log.Fatal(err)
	}
	for _, c := range good {
		fmt.Println(c["data"].(M)["score"], c["data"].(M)["name"])
	}

See Querying for text search, totals and saved views.

#Link records

A relationship type such as works_at links a contact to a company. Create a link, then list the records on the other side:

Goexamples/languages/go/main.go
	company, err := call("POST", "/records", Request{JSON: M{"object": "company", "data": M{"name": "Example Ltd " + run}}})
	if err != nil {
		log.Fatal(err)
	}
	_, err = call("POST", "/links", Request{
		JSON:           M{"relationship": "works_at", "source_record_id": adaID, "target_record_id": company["id"]},
		IdempotencyKey: fmt.Sprintf("link-%s-%s", adaID, company["id"]),
	})
	if err != nil {
		log.Fatal(err)
	}
	related, err := call("GET", "/records/"+adaID+"/related?relationship=works_at", Request{})
	if err != nil {
		log.Fatal(err)
	}
	var employers []string
	for _, r := range related["records"].([]any) {
		employers = append(employers, r.(M)["data"].(M)["name"].(string))
	}
	fmt.Println("Ada works at", strings.Join(employers, ", "))

Add direction=incoming to list from the other side, for example all contacts of a company.

#Files

A file upload has three steps: announce the file with its name, type and size; send the raw bytes; attach it to a record. AgentDB checks that the bytes match the type.

Goexamples/languages/go/main.go
	content := []byte("Meeting notes for Ada (" + run + ")\n")
	// 1. Announce the file, 2. send the raw bytes, 3. attach it to a record.
	file, err := call("POST", "/files", Request{JSON: M{"filename": "notes.txt", "content_type": "text/plain", "size": len(content)}})
	if err != nil {
		log.Fatal(err)
	}
	fileID := file["id"].(string)
	if _, err := call("PUT", "/files/"+fileID+"/content", Request{Body: content}); err != nil {
		log.Fatal(err)
	}
	if _, err := call("POST", "/attachments", Request{JSON: M{"file_id": fileID, "record_id": adaID}}); err != nil {
		log.Fatal(err)
	}
	// Download with the key (server side) ...
	download, err := send("GET", "/files/"+fileID+"/content", Request{})
	if err != nil {
		log.Fatal(err)
	}
	back, err := io.ReadAll(download.Body)
	download.Body.Close()
	if err != nil {
		log.Fatal(err)
	}
	// ... or make a signed link that expires, for an <img> or a download button in your page.
	link, err := call("POST", "/files/"+fileID+"/links", Request{JSON: M{"expires_in_seconds": 600}})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Signed link until", link["expires_at"])

To show a file in a browser, give the page the signed link, never your key. The link expires and can be revoked. See Files and imports.

#Errors

Every error has a stable code, a message, a retryable flag and details, plus an HTTP status. Act on the code.

Goexamples/languages/go/main.go
	_, err = call("GET", "/records/rec_doesnotexist", Request{})
	var apiErr *AgentDBError
	if errors.As(err, &apiErr) {
		fmt.Println(apiErr.Status, apiErr.Code, apiErr.Message) // 404 NOT_FOUND ...
		if apiErr.Retryable {
			fmt.Println("Safe to retry later")
		}
	} else if err != nil {
		log.Fatal(err) // a network error, not an AgentDB answer
	}

Go returns errors as values; the helper returns an *AgentDBError for AgentDB answers, and other errors for network trouble.

Common codes:

CodeHTTPWhat to do
VALIDATION_ERROR, FIELD_TYPE_MISMATCH400Fix the request; details names the field.
UNAUTHENTICATED401Check the key.
FORBIDDEN403The key's role or a permission rule does not allow this.
NOT_FOUND404Check the id and the workspace.
VERSION_CONFLICT409Read again and retry the update.
RATE_LIMITED429Wait for Retry-After, then retry.

The error codes page lists them all.

#Rate limits and retries

AgentDB limits how many requests a key and a workspace may send. Over the limit, it answers 429 RATE_LIMITED with a Retry-After header in seconds.

The request helper above already handles this:

  • On 429 or 503, it waits for Retry-After, or backs off (0.5, 1, 2, 4 seconds), then tries again.
  • On a network error, it retries only reads and writes with an idempotency key.
  • It gives up after a few attempts and reports the error.

To load many records, use one batch call instead of one call per record: POST /records/upsert takes up to 500 items. See records_upsert_batch.

#Idempotency keys

A timeout can leave you unsure whether a write happened. Send an Idempotency-Key header with each write you may retry. If the same key comes again with the same request, AgentDB returns the first result and writes nothing twice. Keys are kept for 7 days.

Goexamples/languages/go/main.go
	key := randomUUID() // one key per intention; reuse it only to retry the same request
	request := M{"object": "contact", "data": M{"name": "Mary Somerville", "email": "mary-" + run + "@example.com"}}
	first, err := call("POST", "/records", Request{JSON: request, IdempotencyKey: key})
	if err != nil {
		log.Fatal(err)
	}
	retry, err := call("POST", "/records", Request{JSON: request, IdempotencyKey: key}) // e.g. after a timeout
	if err != nil {
		log.Fatal(err)
	}
	if first["id"] == retry["id"] {
		fmt.Println("Same record, written once")
	} else {
		fmt.Println("Duplicate!")
	}

Use a new key for each new intention, such as each form submission. The same key with a different request fails with IDEMPOTENCY_KEY_REUSED.

#Run the full example

The complete program is examples/languages/go/main.go. Set the three environment variables and run:

Shell
go run .

It prints one OK line per topic: OK connect, OK create, OK read, OK update, OK query, OK relationships, OK files, OK errors and OK idempotency.