DigitalOcean Gradient™ AI Agentic Cloud

https://gradientai-sdk.digitalocean.com/
Admin
The Gradient™ SDK helps developers train large models, run inference, and build AI applications on...
Tokens:562,920
Snippets:2,722
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Gradient SDK

Source: https://gradientai-sdk.digitalocean.com/api/python

Install the library from PyPI using pip.

```bash
# install from PyPI
pip install gradient
```

--------------------------------

### Retrieve Workspace Go Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/subresources/workspaces/methods/retrieve

Example usage of the Go SDK to retrieve a workspace by its UUID.

```go
package main

import (
  "context"
  "fmt"
```

--------------------------------

### Install Gradient AI SDK

Source: https://gradientai-sdk.digitalocean.com/api

Commands to install the Gradient AI SDK for TypeScript, Python, and Go.

```bash
npm install @digitalocean/gradient
```

```bash
pip install gradient
```

```bash
go get -u 'github.com/stainless-sdks/-go@v0.0.1'
```

--------------------------------

### Bulk Initiate Action Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/actions/methods/bulk_initiate

Example of a successful 200 response returned after initiating bulk actions.

```json
{
  "actions": [
    {
      "id": 36804636,
      "completed_at": "2020-11-14T16:30:06Z",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "name": "New York 3",
        "sizes": [
          "s-1vcpu-1gb",
          "s-1vcpu-2gb",
          "s-1vcpu-3gb",
          "s-2vcpu-2gb",
          "s-3vcpu-1gb",
          "s-2vcpu-4gb",
          "s-4vcpu-8gb",
          "s-6vcpu-16gb",
          "s-8vcpu-32gb",
          "s-12vcpu-48gb",
          "s-16vcpu-64gb",
          "s-20vcpu-96gb",
          "s-24vcpu-128gb",
          "s-32vcpu-192g"
        ],
        "slug": "nyc3"
      },
      "region_slug": "nyc3",
      "resource_id": 3164444,
      "resource_type": "droplet",
      "started_at": "2020-11-14T16:29:21Z",
      "status": "completed",
      "type": "create"
    }
  ]
}
```

--------------------------------

### NFS share retrieval response example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/nfs/methods/retrieve

Example JSON response returned upon a successful GET request.

```json
{
  "share": {
    "id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "name": "sammy-share-drive",
    "size_gib": 1024,
    "region": "atl1",
    "status": "ACTIVE",
    "created_at": "2023-01-01T00:00:00Z",
    "vpc_ids": [
      "796c6fe3-2a1d-4da2-9f3e-38239827dc91"
    ],
    "mount_path": "/123456/your-nfs-share-uuid",
    "host": "10.128.32.2"
  }
}
```

--------------------------------

### List Firewalls Go Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/methods/list_firewalls

Demonstrates how to initialize the Gradient client and call the ListFirewalls method for a specific droplet ID.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  response, err := client.GPUDroplets.ListFirewalls(
    context.TODO(),
    int64(3164444),
    gradient.GPUDropletListFirewallsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}
```

--------------------------------

### List Workspaces Go Implementation

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/subresources/workspaces/methods/list

Initializes the client and prepares the context for listing workspaces.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)
```

--------------------------------

### Schema Registry Configuration Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/databases/subresources/schema_registry/subresources/config/methods/retrieve

Example JSON response body returned upon a successful GET request.

```json
{
  "compatibility_level": "NONE"
}
```

--------------------------------

### List Regions with Go SDK

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/regions/methods/list

Example of initializing the client and listing regions using the Go SDK.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  regions, err := client.Regions.List(context.TODO(), gradient.RegionListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", regions.Meta)
}
```

--------------------------------

### Retrieve a Volume with Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/volumes/methods/retrieve

Example usage of the Get method to retrieve volume details using the Go SDK.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  volume, err := client.GPUDroplets.Volumes.Get(context.TODO(), "7724db7c-e098-11e5-b522-000f53304e51")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", volume.Volume)
}
```

--------------------------------

### List NFS snapshots in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/nfs/subresources/snapshots/methods/list

Demonstrates how to initialize the client and list snapshots using the Go SDK.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  snapshots, err := client.Nfs.Snapshots.List(context.TODO(), gradient.NfSnapshotListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", snapshots.Snapshots)
}
```

--------------------------------

### Create an NFS share in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/nfs/methods/create

Demonstrates how to initialize the client and call the Nfs.New method to provision a new share.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  nf, err := client.Nfs.New(context.TODO(), gradient.NfNewParams{
    Name: gradient.F("sammy-share-drive"),
    Region: gradient.F("atl1"),
    SizeGib: gradient.F(int64(1024)),
    VpcIDs: gradient.F([]string{"796c6fe3-2a1d-4da2-9f3e-38239827dc91"}),
    PerformanceTier: gradient.F("standard"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", nf.Share)
}
```

--------------------------------

### Install TypeScript SDK

Source: https://gradientai-sdk.digitalocean.com/getting-started/overview

Use npm to install the Gradient TypeScript package.

```bash
npm install @digitalocean/gradient
```

--------------------------------

### 200 Response Example

Source: https://gradientai-sdk.digitalocean.com/api/python/resources/agents/subresources/routes/methods/view

Example JSON response structure returned by the view method.

```json
{
  "children": [
    {
      "anthropic_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "api_key_infos": [
        {
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "deleted_at": "2023-01-01T00:00:00Z",
          "name": "example name",
          "secret_key": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "api_keys": [
        {
          "api_key": "example string"
        }
      ],
      "chatbot": {
        "allowed_domains": [
          "example string"
        ],
        "button_background_color": "example string",
        "logo": "example string",
        "name": "example name",
        "primary_color": "example string",
        "secondary_color": "example string",
        "starting_message": "example string"
      },
      "chatbot_identifiers": [
        {
          "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "child_agents": [],
      "conversation_logs_enabled": true,
      "created_at": "2023-01-01T00:00:00Z",
      "deployment": {
        "created_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "status": "STATUS_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "visibility": "VISIBILITY_UNKNOWN"
      },
      "description": "example string",
      "functions": [
        {
          "api_key": "example string",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "input_schema": {},
          "name": "example name",
          "output_schema": {},
          "updated_at": "2023-01-01T00:00:00Z",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "guardrails": [
        {
          "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2023-01-01T00:00:00Z",
          "default_response": "example string",
          "description": "example string",
          "guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_attached": true,
          "is_default": true,
          "metadata": {},
          "name": "example name",
          "priority": 123,
          "type": "GUARDRAIL_TYPE_UNKNOWN",
          "updated_at": "2023-01-01T00:00:00Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "if_case": "example string",
      "instruction": "example string",
      "k": 123,
      "knowledge_bases": [
        {
          "added_to_agent_at": "2023-01-01T00:00:00Z",
          "created_at": "2023-01-01T00:00:00Z",
          "database_id": "123e4567-e89b-12d3-a456-426614174000",
          "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "is_public": true,
          "last_indexing_job": {
            "completed_datasources": 123,
            "created_at": "2023-01-01T00:00:00Z",
            "data_source_jobs": [
              {
                "completed_at": "2023-01-01T00:00:00Z",
                "data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
                "error_details": "example string",
                "error_msg": "example string",
                "failed_item_count": "12345",
                "indexed_file_count": "12345",
                "indexed_item_count": "12345",
                "removed_item_count": "12345",
                "skipped_item_count": "12345",
                "started_at": "2023-01-01T00:00:00Z",
                "status": "DATA_SOURCE_STATUS_UNKNOWN",
                "total_bytes": "12345",
                "total_bytes_indexed": "12345",
                "total_file_count": "12345"
              }
            ],
            "data_source_uuids": [
              "example string"
            ],
            "finished_at": "2023-01-01T00:00:00Z",
            "is_report_available": true,
            "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
            "phase": "BATCH_JOB_PHASE_UNKNOWN",
            "started_at": "2023-01-01T00:00:00Z",
            "status": "INDEX_JOB_STATUS_UNKNOWN",
            "tokens": 123,
            "total_datasources": 123,
            "total_tokens": "12345",
            "updated_at": "2023-01-01T00:00:00Z",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
```

--------------------------------

### Initiate an NFS action in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/nfs/methods/initiate_action

Demonstrates how to initialize the client and trigger a resize action on an NFS share.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  response, err := client.Nfs.InitiateAction(
    context.TODO(),
    "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    gradient.NfInitiateActionParams{
      Body: gradient.NfInitiateActionParamsBodyNfsActionResize{
        Type: gradient.F(gradient.NfInitiateActionParamsBodyNfsActionResizeTypeResize),
      },
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Action)
}
```

--------------------------------

### Create a New SSH Key in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/account/subresources/keys/methods/create

Example demonstrating how to initialize the client and call the New method to add an SSH key.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  key, err := client.GPUDroplets.Account.Keys.New(context.TODO(), gradient.GPUDropletAccountKeyNewParams{
    SSHKeys: gradient.SSHKeysParam{
      Name: gradient.F("My SSH Public Key"),
      PublicKey: gradient.F("ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example"),
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", key.SSHKey)
}
```

--------------------------------

### Install aiohttp dependency

Source: https://gradientai-sdk.digitalocean.com/api/python

Install the necessary package to enable aiohttp as the HTTP backend.

```bash
# install from PyPI
pip install gradient[aiohttp]
```

--------------------------------

### Create a Volume Snapshot in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/volumes/subresources/snapshots/methods/create

Demonstrates how to initialize the client and call the New method to create a snapshot for a specific volume ID.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  snapshot, err := client.GPUDroplets.Volumes.Snapshots.New(
    context.TODO(),
    "7724db7c-e098-11e5-b522-000f53304e51",
    gradient.GPUDropletVolumeSnapshotNewParams{
      Name: gradient.F("big-data-snapshot1475261774"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", snapshot.Snapshot)
}
```

--------------------------------

### 200 OK response example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/subresources/openai/subresources/keys/methods/list_agents

Example JSON response structure returned when the request is successful.

```json
{
  "agents": [
    {
      "anthropic_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "api_key_infos": [
        {
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "deleted_at": "2023-01-01T00:00:00Z",
          "name": "example name",
          "secret_key": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "api_keys": [
        {
          "api_key": "example string"
        }
      ],
      "chatbot": {
        "allowed_domains": [
          "example string"
        ],
        "button_background_color": "example string",
        "logo": "example string",
        "name": "example name",
        "primary_color": "example string",
        "secondary_color": "example string",
        "starting_message": "example string"
      },
      "chatbot_identifiers": [
        {
          "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "child_agents": [],
      "conversation_logs_enabled": true,
      "created_at": "2023-01-01T00:00:00Z",
      "deployment": {
        "created_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "status": "STATUS_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "visibility": "VISIBILITY_UNKNOWN"
      },
      "description": "example string",
      "functions": [
        {
          "api_key": "example string",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "input_schema": {},
          "name": "example name",
          "output_schema": {},
          "updated_at": "2023-01-01T00:00:00Z",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "guardrails": [
        {
          "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2023-01-01T00:00:00Z",

```

--------------------------------

### Agent Return Example

Source: https://gradientai-sdk.digitalocean.com/api/typescript/resources/agents/methods/create

Example structure of the JSON object returned when interacting with agent resources.

```json
{
  "updated_at": "2023-01-01T00:00:00Z",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"name": "example name",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"region": "example string",
"tags": [
  "example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"user_id": "user_id",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
```

--------------------------------

### List SSH Keys in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/account/subresources/keys/methods/list

Demonstrates how to initialize the client and retrieve the list of SSH keys using the SDK.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  keys, err := client.GPUDroplets.Account.Keys.List(context.TODO(), gradient.GPUDropletAccountKeyListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", keys.Meta)
}
```

--------------------------------

### Create a Knowledge Base in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/knowledge_bases/methods/create

Initializes a client with an access token and creates a new knowledge base instance.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  knowledgeBase, err := client.KnowledgeBases.New(context.TODO(), gradient.KnowledgeBaseNewParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", knowledgeBase.KnowledgeBase)
}
```

--------------------------------

### Image generation response example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/images/methods/generate

Example JSON response returned by the image generation endpoint.

```json
{
  "created": 1677649456,
  "data": [
    {
      "b64_json": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEX...",
      "revised_prompt": "A cute baby sea otter floating on its back in calm blue water, captured with professional photography lighting and composition"
    }
  ],
  "background": "opaque",
  "output_format": "png",
  "quality": "high",
  "size": "1024x1024",
  "usage": {
    "input_tokens": 12,
    "total_tokens": 4172,
    "input_tokens_details": {
      "text_tokens": 12
    },
    "output_tokens": 4160
  }
}
```

--------------------------------

### API Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/destroy_with_associated_resources/methods/list

Example JSON response structure containing lists of associated resources.

```json
{
  "floating_ips": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "reserved_ips": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "snapshots": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "volume_snapshots": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ],
  "volumes": [
    {
      "id": "61486916",
      "cost": "0.05",
      "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330"
    }
  ]
}
```

--------------------------------

### List Backup Policies with Go SDK

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/backups/methods/list_policies

Demonstrates how to initialize the client and call the ListPolicies method to retrieve backup policy data.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  response, err := client.GPUDroplets.Backups.ListPolicies(context.TODO(), gradient.GPUDropletBackupListPoliciesParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}
```

--------------------------------

### Initiate a Floating IP Action in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/floating_ips/subresources/actions/methods/create

Example demonstrating how to use the Go SDK to initiate an action on a specific floating IP.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  action, err := client.GPUDroplets.FloatingIPs.Actions.New(
    context.TODO(),
    "45.55.96.47",
    gradient.GPUDropletFloatingIPActionNewParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", action.Action)
}
```

--------------------------------

### List History Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/autoscale/methods/list_history

Example JSON response body returned by the ListHistory endpoint.

```json
{
  "history": [
    {
      "history_event_id": "01936530-4471-7b86-9634-32d8fcfecbc6",
      "current_instance_count": 2,
      "desired_instance_count": 2,
      "reason": "CONFIGURATION_CHANGE",
      "status": "success",
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z"
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}
```

--------------------------------

### 200 OK response example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/subresources/anthropic/subresources/keys/methods/list_agents

Example JSON response body returned when successfully listing agents.

```json
{
  "agents": [
    {
      "anthropic_api_key": {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      },
      "api_key_infos": [
        {
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "deleted_at": "2023-01-01T00:00:00Z",
          "name": "example name",
          "secret_key": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "api_keys": [
        {
          "api_key": "example string"
        }
      ],
      "chatbot": {
        "allowed_domains": [
          "example string"
        ],
        "button_background_color": "example string",
        "logo": "example string",
        "name": "example name",
        "primary_color": "example string",
        "secondary_color": "example string",
        "starting_message": "example string"
      },
      "chatbot_identifiers": [
        {
          "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "child_agents": [],
      "conversation_logs_enabled": true,
      "created_at": "2023-01-01T00:00:00Z",
      "deployment": {
        "created_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "status": "STATUS_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "visibility": "VISIBILITY_UNKNOWN"
      },
      "description": "example string",
      "functions": [
        {
          "api_key": "example string",
          "created_at": "2023-01-01T00:00:00Z",
          "created_by": "12345",
          "description": "example string",
          "faas_name": "example name",
          "faas_namespace": "example name",
          "input_schema": {},
          "name": "example name",
          "output_schema": {},
          "updated_at": "2023-01-01T00:00:00Z",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "guardrails": [
        {
          "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2023-01-01T00:00:00Z"
```

--------------------------------

### List Evaluation Metrics in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/methods/list

Demonstrates how to initialize the client and call the List method to retrieve evaluation metrics.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  evaluationMetrics, err := client.Agents.EvaluationMetrics.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", evaluationMetrics.Metrics)
}
```

--------------------------------

### List Kernels using Go SDK

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/methods/list_kernels

Demonstrates how to initialize the client and call the ListKernels method to retrieve kernel information for a specific Droplet.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  response, err := client.GPUDroplets.ListKernels(
    context.TODO(),
    int64(3164444),
    gradient.GPUDropletListKernelsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}
```

--------------------------------

### List Anthropic API Keys in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/subresources/anthropic/subresources/keys/methods/list

Demonstrates how to initialize the client and call the List method to retrieve API keys.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  keys, err := client.Agents.EvaluationMetrics.Anthropic.Keys.List(context.TODO(), gradient.AgentEvaluationMetricAnthropicKeyListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", keys.APIKeyInfos)
}
```

--------------------------------

### Delete Agent Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/methods/delete

Example JSON response returned after a successful agent deletion.

```json
{
  "agent": {
    "anthropic_api_key": {
      "created_at": "2023-01-01T00:00:00Z",
      "created_by": "12345",
      "deleted_at": "2023-01-01T00:00:00Z",
      "name": "example name",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "api_key_infos": [
      {
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "deleted_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "secret_key": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "api_keys": [
      {
        "api_key": "example string"
      }
    ],
    "chatbot": {
      "allowed_domains": [
        "example string"
      ],
      "button_background_color": "example string",
      "logo": "example string",
      "name": "example name",
      "primary_color": "example string",
      "secondary_color": "example string",
      "starting_message": "example string"
    },
    "chatbot_identifiers": [
      {
        "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "child_agents": [],
    "conversation_logs_enabled": true,
    "created_at": "2023-01-01T00:00:00Z",
    "deployment": {
      "created_at": "2023-01-01T00:00:00Z",
      "name": "example name",
      "status": "STATUS_UNKNOWN",
      "updated_at": "2023-01-01T00:00:00Z",
      "url": "example string",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "visibility": "VISIBILITY_UNKNOWN"
    },
    "description": "example string",
    "functions": [
      {
        "api_key": "example string",
        "created_at": "2023-01-01T00:00:00Z",
        "created_by": "12345",
        "description": "example string",
        "faas_name": "example name",
        "faas_namespace": "example name",
        "input_schema": {},
        "name": "example name",
        "output_schema": {},
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "guardrails": [
      {
        "agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "created_at": "2023-01-01T00:00:00Z",
        "default_response": "example string",
        "description": "example string",
        "guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "is_attached": true,
        "is_default": true,
        "metadata": {},
        "name": "example name",
        "priority": 123,
        "type": "GUARDRAIL_TYPE_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "if_case": "example string",
    "instruction": "example string",
    "k": 123,
    "knowledge_bases": [
      {
        "added_to_agent_at": "2023-01-01T00:00:00Z",
        "created_at": "2023-01-01T00:00:00Z",
        "database_id": "123e4567-e89b-12d3-a456-426614174000",
        "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "is_public": true,
        "last_indexing_job": {
          "completed_datasources": 123,
          "created_at": "2023-01-01T00:00:00Z",
          "data_source_jobs": [
            {
              "completed_at": "2023-01-01T00:00:00Z"
```

--------------------------------

### List Agents Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/methods/list

Example JSON structure returned by the List Agents endpoint.

```json
{
  "agents": [
    {
      "chatbot": {
        "allowed_domains": [
          "example string"
        ],
        "button_background_color": "example string",
        "logo": "example string",
        "name": "example name",
        "primary_color": "example string",
        "secondary_color": "example string",
        "starting_message": "example string"
      },
      "chatbot_identifiers": [
        {
          "agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "created_at": "2021-01-01T00:00:00Z",
      "deployment": {
        "created_at": "2023-01-01T00:00:00Z",
        "name": "example name",
        "status": "STATUS_UNKNOWN",
        "updated_at": "2023-01-01T00:00:00Z",
        "url": "example string",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "visibility": "VISIBILITY_UNKNOWN"
      },
      "description": "This is a chatbot that can help you with your questions.",
      "if_case": "if talking about the weather use this route",
      "instruction": "Hello, how can I help you?",
      "k": 5,
      "max_tokens": 100,
      "model": {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "kb_default_chunk_size": 123,
        "kb_max_chunk_size": 123,
        "kb_min_chunk_size": 123,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      },
      "name": "My Agent",
      "project_id": "12345678-1234-1234-1234-123456789012",
      "provide_citations": true,
      "region": "\"tor1\"",
      "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
      "route_created_at": "2021-01-01T00:00:00Z",
      "route_created_by": "12345678",
      "route_name": "Route Name",
      "route_uuid": "\"12345678-1234-1234-1234-123456789012\"",
      "tags": [
        "example string"
      ],
      "temperature": 0.5,
      "template": {
        "created_at": "2023-01-01T00:00:00Z",
        "description": "example string",
        "guardrails": [
          {
            "priority": 123,
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "instruction": "example string",
        "k": 123,
        "knowledge_bases": [
          {

```

--------------------------------

### Delete Scheduled Indexing Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/subresources/evaluation_metrics/subresources/scheduled_indexing/methods/delete

Example JSON response returned after a successful deletion.

```json
{
  "indexing_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "days": [
      123
    ],
    "deleted_at": "2023-01-01T00:00:00Z",
    "is_active": true,
    "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "last_ran_at": "2023-01-01T00:00:00Z",
    "next_run_at": "2023-01-01T00:00:00Z",
    "time": "example string",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}
```

--------------------------------

### List Snapshots for a Volume in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/volumes/subresources/snapshots/methods/list

Demonstrates how to initialize the client and call the List method to retrieve snapshots for a specific volume ID.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  snapshots, err := client.GPUDroplets.Volumes.Snapshots.List(
    context.TODO(),
    "7724db7c-e098-11e5-b522-000f53304e51",
    gradient.GPUDropletVolumeSnapshotListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", snapshots.Meta)
}
```

--------------------------------

### Agent Usage Response Example

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/agents/methods/retrieve_usage

Example JSON response structure returned by the GetUsage endpoint.

```json
{
  "log_insights_usage": {
    "measurements": [
      {
        "tokens": 123,
        "usage_type": "example string"
      }
    ],
    "resource_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "start": "2023-01-01T00:00:00Z",
    "stop": "2023-01-01T00:00:00Z"
  },
  "usage": {
    "measurements": [
      {
        "tokens": 123,
        "usage_type": "example string"
      }
    ],
    "resource_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "start": "2023-01-01T00:00:00Z",
    "stop": "2023-01-01T00:00:00Z"
  }
}
```

--------------------------------

### List All Snapshots in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/gpu_droplets/subresources/snapshots/methods/list

Initializes the Gradient client and lists snapshots using the SDK.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  snapshots, err := client.GPUDroplets.Snapshots.List(context.TODO(), gradient.GPUDropletSnapshotListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", snapshots.Meta)
}
```

--------------------------------

### Start Indexing Job in Go

Source: https://gradientai-sdk.digitalocean.com/api/go/resources/knowledge_bases/subresources/indexing_jobs/methods/create

Initializes a new client with an access token and triggers an indexing job for a knowledge base.

```go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  indexingJob, err := client.KnowledgeBases.IndexingJobs.New(context.TODO(), gradient.KnowledgeBaseIndexingJobNewParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", indexingJob.Job)
}
```
Tokens:
Raw