# Agent: Web Search

**Page:** api/agent/web-search

[Download Raw Markdown](./api/agent/web-search.md)

---

{/* AUTO-GENERATED — Do not edit manually. Regenerate with: npm run docs:api:generate */}



The Agent Web Search API lets you check whether web search is enabled and authenticated for a given workspace. Use this endpoint to verify the connection status of the web search backend before relying on search-powered agent features.

## Get web search status

Returns the current web search configuration and authentication status for the specified workspace.

### `GET /api/v1/workspaces/{workspaceID}/web-search/status`

### Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `workspaceID` | path | string | Yes | The unique identifier of the workspace. |

This endpoint accepts no request body.

### Response



```json
{
  "enabled": true,
  "model": "gpt-4o",
  "provider": "openai",
  "authenticated": true
}
```



### SDK Usage

```typescript
const status = await client.agent.webSearch.getStatus({
  workspaceID: "ws_abc123"
});

if (status.enabled && status.authenticated) {
  console.log(`Web search ready via ${status.provider} (${status.model})`);
} else {
  console.log("Web search is not fully configured for this workspace");
}
```