# useRun

<!-- https://uncage.vercel.app/docs/api/react/functions/userun/ -->

```ts
function useRun(): object;
```

Defined in: react/src/hooks.ts:106

## Returns

`object`

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `isActive` | `boolean` | react/src/hooks.ts:106 |
| `run?` | `object` | react/src/hooks.ts:106 |
| `run.attachments?` | `object`[] | protocol/dist/index.d.ts:427 |
| `run.createdAt` | `string` | protocol/dist/index.d.ts:390 |
| `run.endedAt?` | `string` | protocol/dist/index.d.ts:392 |
| `run.error?` | `object` | protocol/dist/index.d.ts:393 |
| `run.error.code` | \| `"runtime_unavailable"` \| `"auth_required"` \| `"unsupported_capability"` \| `"invalid_workspace"` \| `"session_busy"` \| `"session_read_only"` \| `"not_found"` \| `"unauthorized"` \| `"forbidden_origin"` \| `"invalid_request"` \| `"approval_expired"` \| `"approval_already_resolved"` \| `"event_replay_unavailable"` \| `"runtime_disconnected"` \| `"policy_denied"` \| `"store_locked"` \| `"attachment_too_large"` \| `"attachment_type_unsupported"` \| `"machine_offline"` \| `"machine_not_found"` \| `"upgrade_required"` \| `"tool_failed"` \| `"device_code_expired"` \| `"rate_limited"` \| `"internal_error"` | protocol/dist/index.d.ts:394 |
| `run.error.details?` | `Record`\<`string`, `unknown`\> | protocol/dist/index.d.ts:424 |
| `run.error.hint?` | `string` | protocol/dist/index.d.ts:422 |
| `run.error.message` | `string` | protocol/dist/index.d.ts:421 |
| `run.error.requestId?` | `string` | protocol/dist/index.d.ts:425 |
| `run.error.retryable` | `boolean` | protocol/dist/index.d.ts:423 |
| `run.id` | `string` | protocol/dist/index.d.ts:378 |
| `run.prompt` | `string` | protocol/dist/index.d.ts:380 |
| `run.sessionId` | `string` | protocol/dist/index.d.ts:379 |
| `run.startedAt?` | `string` | protocol/dist/index.d.ts:391 |
| `run.state` | \| `"queued"` \| `"running"` \| `"waiting_approval"` \| `"completed"` \| `"failed"` \| `"cancelled"` \| `"interrupted"` | protocol/dist/index.d.ts:381 |
| `cancel()` | () => `Promise`\<`void`\> | react/src/hooks.ts:106 |
| `send()` | (`prompt`) => `Promise`\<`boolean`\> | react/src/hooks.ts:106 |
