useDocyrusAgentInfo
Fetches a Docyrus AI agent's profile, suggestions and capabilities from the agent-deployment endpoint and maps them onto the DocyrusAgent props.
Installation
pnpm dlx @docyrus/cli add @docyrus/rn-hooks-use-docyrus-agent-infopnpm add @tanstack/react-queryA verbatim port of the web hook. It reads GET /v1/ai/agent-deployments/base/{agentId} (or /v1/ai/agent-deployments/{deploymentId}) and returns an AgentProfile (name, description, welcome message, avatar), the agent's standard suggestions, and its feature capabilities, ready to spread onto DocyrusAgent. A QueryClientProvider must be mounted above it.
Usage
import { DocyrusAgent } from '@/components/docyrus-native/docyrus-agent';
import { useDocyrusAgentInfo } from '@/hooks/docyrus-native/use-docyrus-agent-info';
function Assistant({ client }) {
const { agent, suggestions, capabilities } = useDocyrusAgentInfo({ client, agentId: AGENT_ID });
if (!agent) return null;
return <DocyrusAgent agent={agent} suggestions={suggestions} capabilities={capabilities} />;
}API Reference
UseDocyrusAgentInfoArgs
| Option | Type | Default | Description |
|---|---|---|---|
client | DocyrusAgentInfoClient | null | undefined | - | Client with a get(url, params?) method (e.g. RestApiClient) |
agentId | string | null | null | Tenant AI agent ID (base deployment) |
deploymentId | string | null | null | Read a specific deployment instead of the base record |
enabled | boolean | !!client && (agentId || deploymentId) | Toggle the query |
UseDocyrusAgentInfoResult
| Field | Type | Description |
|---|---|---|
agent | AgentProfile | null | Mapped profile, null until loaded |
suggestions | string[] | standardSuggestions of the agent |
capabilities | AgentCapabilities | supportFiles, supportWebSearch, supportDocumentSearch (backend documentSearch), supportThinking, supportDeepResearch, supportWorkCanvas (backend featureWorks), supportMultipleModels, promptOptimizationChoice |
raw | DocyrusAgentDeploymentEnvelope | null | Raw deployment payload |
isLoading | boolean | Query loading flag |
error | Error | null | Query error |
refresh | () => Promise<void> | Refetch |
Query key: ['docyrus-agent', 'info', deploymentId ?? 'base:<agentId>'] (same as web).
useDocyrusAgentChat
The complete streaming chat runtime for a Docyrus AI agent — AI SDK transport, threads, attachment uploads and client-side tool execution — ready to drive DocyrusAgent.
useDocyrusAgentMemories
Backend glue for the DocyrusAgent memory manager — list, create, update and delete /v1/ai/memories with optimistic local state.