# OSS Coordinator

Go inputs, results, permissions and executable examples for oss coordinator.

Use this reference with the [complete developer tour](https://beepgrid.com/docs/sdks/go/tour.md) and [Go types](https://beepgrid.com/docs/sdks/go/types.md). The example at the end runs after the tour setup.

## Assistance

Read OSS Coordinator enablement and provider configuration status.

```text
func (c *Client) Assistance(ctx context.Context) (AssistanceSettings, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |

**Returns:** AssistanceSettings: overseer, version, overseer_configured.

**Permissions, lifecycle and errors:** Provider configured and workspace enabled are separate states. The wire name overseer is retained for SDK/API compatibility; the product calls it Coordinator.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## UpdateAssistance

Enable or disable Coordinator through the public API, without the UI.

```text
func (c *Client) UpdateAssistance(ctx context.Context, in AssistanceUpdate) (AssistanceSettings, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |
| `in` | `AssistanceUpdate` (required) | Typed operation input. Every field is listed in the language types reference. |

**Returns:** Current AssistanceSettings after the update.

**Permissions, lifecycle and errors:** A person needs manage assistance:workspace. Configure a provider on the engine first. Use version to reject stale updates; disabling invalidates unconfirmed plans.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## PlanOverseer

Prepare a reviewable Coordinator plan using the caller's authorized specialist context.

```text
func (c *Client) PlanOverseer(ctx context.Context, in OverseerInput, keys ...string) (OverseerPlan, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |
| `in` | `OverseerInput` (required) | Typed operation input. Every field is listed in the language types reference. |
| `keys` | `...string` (default optional) | Optional Go operation key for model-backed writes. Retain it across unknown transport outcomes. |

**Returns:** OverseerPlan with operation, sources, selected agents, instructions, expiry and requires_confirmation.

**Permissions, lifecycle and errors:** Does not automatically dispatch the plan. Model failures send no instructions. Retain the key for a transport-unknown result; optional target narrows scope and previous_plan_id supplies permitted prior context.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## OverseerPlans

List Coordinator plans visible to the current person.

```text
func (c *Client) OverseerPlans(ctx context.Context) ([]OverseerPlan, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |

**Returns:** Array of OverseerPlan.

**Permissions, lifecycle and errors:** Another person's plans are not implicitly shared. Plans do not grant permission; current access is rechecked on use.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## OverseerPlan

Read one Coordinator plan and its current dispatch/reply state.

```text
func (c *Client) OverseerPlan(ctx context.Context, id string) (OverseerPlan, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |
| `id` | `string` (required) | Existing stable resource ID, returned by the corresponding create/read operation. |

**Returns:** OverseerPlan, with dispatches, replies and any reply_summary.

**Permissions, lifecycle and errors:** A returned request may still be open. Do not present an instruction's acceptance as finished specialist work.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## ConfirmOverseer

Dispatch a still-valid reviewed plan.

```text
func (c *Client) ConfirmOverseer(ctx context.Context, id string) (OverseerPlan, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |
| `id` | `string` (required) | Existing stable resource ID, returned by the corresponding create/read operation. |

**Returns:** OverseerPlan containing attributed dispatches.

**Permissions, lifecycle and errors:** Uses only the saved server plan ID. Rechecks current permissions, scope, enablement and expiry. Repeating confirmation reuses that plan's dispatch, not a new arbitrary model command.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## SummarizeOverseer

Ask the configured model to summarize currently authorized specialist replies.

```text
func (c *Client) SummarizeOverseer(ctx context.Context, id string) (OverseerPlan, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |
| `id` | `string` (required) | Existing stable resource ID, returned by the corresponding create/read operation. |

**Returns:** Updated OverseerPlan with reply_summary, replies, digest or summary_error.

**Permissions, lifecycle and errors:** Pending and missing replies must stay explicit. Summary is not an action or independent factual verification. Provider billing and the per-person rate limit apply.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## Coordinate

Let Coordinator choose specialists and dispatch permitted communication automatically.

```text
func (c *Client) Coordinate(ctx context.Context, in OverseerInput, keys ...string) (OverseerPlan, error)
```

| Parameter | Type and default | Usage |
| --- | --- | --- |
| `ctx` | `context.Context` (required) | Required Go context. Cancellation bounds this local call; it does not withdraw a durable request. |
| `in` | `OverseerInput` (required) | Typed operation input. Every field is listed in the language types reference. |
| `keys` | `...string` (default optional) | Optional Go operation key for model-backed writes. Retain it across unknown transport outcomes. |

**Returns:** OverseerPlan marked automatic, with attributed instructions/dispatches or a status answer.

**Permissions, lifecycle and errors:** No UI preview is required. Uses the caller's current rights, not an operator override. It cannot approve business actions, change identities or grant permissions. Model execution is billed by the configured provider.

[Working Go example](https://beepgrid.com/docs/sdks/go/coordinator/#example). Input/output fields are in the [types reference](https://beepgrid.com/docs/sdks/go/types.md).

## Example

Run this region after [the shared setup](https://beepgrid.com/docs/sdks/go/tour.md). Assertions check the returned data; the full tour is a runnable program.



```go
settings := must(owner.Assistance(ctx))
check(settings.OverseerConfigured)
enabled := true
must(owner.UpdateAssistance(ctx, beepgrid.AssistanceUpdate{Overseer: &enabled, Version: settings.Version}))
plan := must(owner.PlanOverseer(ctx, beepgrid.OverseerInput{Prompt: "Ask the available specialists whether staging is ready."}, beepgrid.Key()))
check(must(owner.OverseerPlan(ctx, plan.ID)).ID == plan.ID)
check(len(must(owner.OverseerPlans(ctx))) > 0)
check(must(owner.ConfirmOverseer(ctx, plan.ID)).ID == plan.ID)
time.Sleep(1100 * time.Millisecond)
check(must(owner.SummarizeOverseer(ctx, plan.ID)).ID == plan.ID)
time.Sleep(1100 * time.Millisecond)
check(must(owner.Coordinate(ctx, beepgrid.OverseerInput{Prompt: "Ask the specialists to report any release blockers."}, runID+"/coordinate")).ID != "")
```