## Get an agent by ID

`client.Agents.Get(ctx, id) (*Agent, error)`

**get** `/v1/agents/{id}`

Retrieves an agent by ID from the workspace

### Parameters

- `id string`

### Returns

- `type Agent struct{…}`

  Agent resource

  - `Metadata ResourceMetadata`

    Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

    - `ID string`

      Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

    - `AccountID string`

      Account this resource belongs to for multi-tenant isolation (prefixed ULID)

    - `CreatedAt Time`

      Timestamp when this resource was created

    - `Name string`

      Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
      Required for resources that users interact with directly

    - `ProfileID string`

      ID of the actor (user or service account) that created this resource

    - `WorkspaceID string`

      Workspace this resource belongs to for organizational grouping (prefixed ULID)

    - `ExternalID string`

      External ID for the resource (e.g., a workflow ID from an external system)

    - `Labels map[string, string]`

      Arbitrary key-value pairs for categorization and filtering
      Examples: {"environment": "production", "team": "platform", "version": "v2"}

  - `Spec AgentSpec`

    Agent specification (user-provided configuration)

    - `Status AgentSpecStatus`

      Status of the agent

      - `const AgentSpecStatusAgentStatusUnspecified AgentSpecStatus = "AGENT_STATUS_UNSPECIFIED"`

      - `const AgentSpecStatusAgentStatusDraft AgentSpecStatus = "AGENT_STATUS_DRAFT"`

      - `const AgentSpecStatusAgentStatusPublished AgentSpecStatus = "AGENT_STATUS_PUBLISHED"`

      - `const AgentSpecStatusAgentStatusArchived AgentSpecStatus = "AGENT_STATUS_ARCHIVED"`

    - `VariationSelectionMode AgentSpecVariationSelectionMode`

      Controls how variations are automatically selected when creating objectives
      Defaults to RANDOM when unspecified

      - `const AgentSpecVariationSelectionModeVariationSelectionModeUnspecified AgentSpecVariationSelectionMode = "VARIATION_SELECTION_MODE_UNSPECIFIED"`

      - `const AgentSpecVariationSelectionModeVariationSelectionModeRandom AgentSpecVariationSelectionMode = "VARIATION_SELECTION_MODE_RANDOM"`

      - `const AgentSpecVariationSelectionModeVariationSelectionModeWeighted AgentSpecVariationSelectionMode = "VARIATION_SELECTION_MODE_WEIGHTED"`

    - `Description string`

      Description of the agent's purpose

    - `WebhookEventsURL string`

      The URL that Cadenya will send events for any objective assigned to the agent.

  - `Info AgentInfo`

    AgentInfo contains simple information about an agent for display or quick reference

    - `CreatedBy Profile`

      Profile represents a human user at the account level.
      Profiles are account-scoped resources that can be associated with multiple workspaces
      through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

      - `Metadata AccountResourceMetadata`

        AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

        - `ID string`

          Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

        - `AccountID string`

          Account this resource belongs to for multi-tenant isolation (prefixed ULID)

        - `Name string`

          Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
          Required for resources that users interact with directly

        - `ProfileID string`

        - `ExternalID string`

          External ID for the resource (e.g., a workflow ID from an external system)

        - `Labels map[string, string]`

          Arbitrary key-value pairs for categorization and filtering
          Examples: {"environment": "production", "team": "platform", "version": "v2"}

      - `Spec ProfileSpec`

        ProfileSpec contains the profile-specific fields

        - `Type ProfileSpecType`

          Type is the type of profile. User's are humans, API keys are computers. You know the deal.

          - `const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"`

          - `const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"`

          - `const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"`

        - `Email string`

          Email address of the user (required, unique per account)

        - `Name string`

          Display name for the user (e.g., "Bobby Tables")

    - `VariationCount int64`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cadenya/cadenya-go"
  "github.com/cadenya/cadenya-go/option"
)

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  agent, err := client.Agents.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", agent.Metadata)
}
```

#### Response

```json
{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "status": "AGENT_STATUS_UNSPECIFIED",
    "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED",
    "description": "description",
    "webhookEventsUrl": "webhookEventsUrl"
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_USER",
        "email": "email",
        "name": "name"
      }
    },
    "variationCount": 0
  }
}
```