> For the complete documentation index, see [llms.txt](https://docs.autonomi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.autonomi.com/developers/sdk/reference/language-bindings/ruby.md).

# Ruby

Use the Ruby SDK to store and retrieve data through a local daemon, a background service called antd. The client uses REST by default, with an optional gRPC client.

## Install

Use Ruby 3.1 or later. Install the [antd gem](https://rubygems.org/gems/antd) from RubyGems:

```bash
gem install antd
```

In a Bundler project, run `bundle add antd` instead. Examples on this page use the `antd` gem 0.2 with antd 0.14.

For gRPC, also install the optional runtime dependency:

```bash
gem install grpc --version '~> 1.60'
```

## Connect to antd

Follow [Start the Local Daemon](/developers/sdk/how-to-guides/start-the-local-daemon.md) to run antd before connecting.

```ruby
require "antd"

begin
  client = Antd::Client.new(base_url: "http://localhost:8082")
  health = client.health
  puts "antd version: #{health.version}"
rescue Antd::AntdError => e
  abort "antd request failed: #{e.message}"
end
```

Expected output:

```
antd version: <version>
```

## Store and retrieve data

Start **antd** in a write-enabled mode before you upload. The public Autonomi Network requires [wallet and Ethereum Virtual Machine (EVM) payment configuration](/developers/how-to-guides/prepare-a-wallet-for-uploads.md). A local development network created with [`ant dev start`](/developers/how-to-guides/set-up-a-local-network.md) includes that configuration.

```ruby
require "antd"

begin
  client = Antd::Client.new
  payload = "Hello, Autonomi!"
  result = client.data_put_public(payload)
  puts "Stored at: #{result.address}"

  data = client.data_get_public(result.address)
  raise "downloaded data did not match the upload" unless data == payload

  puts "Retrieved: #{data}"
rescue Antd::AntdError => e
  abort "antd request failed: #{e.message}"
end
```

Expected output:

```
Stored at: <64-character hexadecimal address>
Retrieved: Hello, Autonomi!
```

## Type mappings

| Autonomi type  | Ruby type                              |
| -------------- | -------------------------------------- |
| `HealthStatus` | model object with `ok` and `network`   |
| `PutResult`    | model object with `cost` and `address` |
| Raw data       | `String`                               |

## Error handling

An address with no stored data raises `Antd::NotFoundError`, a subclass of `Antd::AntdError`.

```ruby
require "antd"

begin
  client = Antd::Client.new
  client.data_get_public("0" * 64)
rescue Antd::NotFoundError
  puts "No data is stored at that address"
rescue Antd::AntdError => e
  puts e.message
end
```

Output when the valid address is not stored:

```
No data is stored at that address
```

External-signer finalize methods raise `Antd::PartialUploadError`, a subclass of `Antd::NetworkError`, when some chunks remain unstored; it carries `chunks_stored`, `chunks_failed`, `total_chunks`, `retryable`, and `retention_known`. When `retryable` is `true`, repeating the same finalize call with the same upload ID stores the remainder without paying again; see the [external-signer guide](/developers/sdk/how-to-guides/use-external-signers-for-upload-payments.md) for the other cases.

## Full API reference

For all available **antd** endpoints, see the [REST API](/developers/sdk/reference/rest-api.md).