> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: SubAgent

> TypeScript SDK reference

[weave](../) / SubAgent

## Hierarchy

* `SpanBase`

  ↳ `SubAgent`

## Table of contents

### Accessors

* [model](./subagent#model)
* [name](./subagent#name)

### Methods

* [addEvent](./subagent#addevent)
* [end](./subagent#end)
* [record](./subagent#record)
* [setAttributes](./subagent#setattributes)
* [create](./subagent#create)

## Accessors

### model

• `get` **model**(): `string`

#### Returns

`string`

#### Defined in

[src/genai/subagent.ts:78](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/subagent.ts#L78)

***

### name

• `get` **name**(): `string`

#### Returns

`string`

#### Defined in

[src/genai/subagent.ts:74](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/subagent.ts#L74)

## Methods

### addEvent

<Warning>
  **Deprecated.** Record this data via [setAttributes](./subagent#setattributes) instead.
  OpenTelemetry is phasing out the Span Event API (`Span.addEvent`). This
  method still works and existing span-event data stays valid.
  See [https://opentelemetry.io/blog/2026/deprecating-span-events/](https://opentelemetry.io/blog/2026/deprecating-span-events/)

  `Example`

  ```ts twoslash theme={null}
  // @noErrors
  span.addEvent('context_compacted', {removedMessages: 12});
  ```
</Warning>

▸ **addEvent**(`name`, `attributes?`, `startTime?`): `this`

Add a named event to the span. Useful for marking non-span moments such as
context compaction, tool-loop detection, or guardrail trips. Warns and
no-ops after `end()`. Mirrors OTel `Span.addEvent`.

#### Parameters

| Name          | Type         |
| :------------ | :----------- |
| `name`        | `string`     |
| `attributes?` | `Attributes` |
| `startTime?`  | `TimeInput`  |

#### Returns

`this`

#### Inherited from

SpanBase.addEvent

#### Defined in

[src/genai/spanBase.ts:82](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/spanBase.ts#L82)

***

### end

▸ **end**(`opts?`): `void`

Read current field values (to reflect mutations made via `record()`
since `start`) and close the span. Idempotent. Pass `error` to mark
it as failed; pass `endTime` to backdate the close.

#### Parameters

| Name    | Type             |
| :------ | :--------------- |
| `opts?` | `SpanEndOptions` |

#### Returns

`void`

#### Defined in

[src/genai/subagent.ts:153](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/subagent.ts#L153)

***

### record

▸ **record**(`opts`): `this`

Bulk-set any fields. Replaces (does not merge).

#### Parameters

| Name                       | Type        |
| :------------------------- | :---------- |
| `opts`                     | `Object`    |
| `opts.agentDescription?`   | `string`    |
| `opts.agentId?`            | `string`    |
| `opts.agentVersion?`       | `string`    |
| `opts.model?`              | `string`    |
| `opts.name?`               | `string`    |
| `opts.systemInstructions?` | `string`\[] |

#### Returns

`this`

#### Defined in

[src/genai/subagent.ts:117](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/subagent.ts#L117)

***

### setAttributes

▸ **setAttributes**(`attributes`): `this`

Set multiple attributes on the span at once. Warns and no-ops after
`end()`. Mirrors OTel `Span.setAttributes` (and the Python SDK's
`set_attributes`).

#### Parameters

| Name         | Type         |
| :----------- | :----------- |
| `attributes` | `Attributes` |

#### Returns

`this`

`Example`

```ts twoslash theme={null}
// @noErrors
span.setAttributes({'weave.tag': 'prod', 'gen_ai.response.id': id});
```

#### Inherited from

SpanBase.setAttributes

#### Defined in

[src/genai/spanBase.ts:63](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/spanBase.ts#L63)

***

### create

▸ **create**(`opts`): [`SubAgent`](./subagent)

#### Parameters

| Name   | Type                                                              |
| :----- | :---------------------------------------------------------------- |
| `opts` | [`SubAgentInit`](../interfaces/subagentinit) & `ChildSpanContext` |

#### Returns

[`SubAgent`](./subagent)

#### Defined in

[src/genai/subagent.ts:93](https://github.com/wandb/weave/blob/8c5f077eb11c42b84000726ff20504abc728d3fb/sdks/node/src/genai/subagent.ts#L93)