AgentFlowClient

AgentFlowClient is the main class in the @10xscale/agentflow-client package. It wraps every 10xGraph REST endpoint behind a single, strongly-typed object so that TypeScript and JavaScript applications can call an 10xGraph-powered API without writing any fetch code themselves.

Package: @10xscale/agentflow-client
Source: src/client.ts

Installation

npm install @10xscale/agentflow-client

Import

import { AgentFlowClient } from '@10xscale/agentflow-client';

Constructor

new AgentFlowClient(config: AgentFlowConfig)

AgentFlowConfig

Example

import { AgentFlowClient } from '@10xscale/agentflow-client';

const client = new AgentFlowClient({
  baseUrl: 'http://localhost:8000',
  auth: {
    type: 'bearer',
    token: process.env.API_TOKEN!,
  },
  timeout: 120_000,   // 2 minutes
  debug: false,
});

Method Overview

The table below lists every public method on AgentFlowClient grouped by domain. Full details for each group are in the linked reference pages.

Graph control

See reference/client/graph for full details on the graph-control methods.

Invoke and stream

Realtime audio

Threads and state

See reference/client/threads for full details.

Memory store

See reference/client/memory for full details.

Files and media

See reference/client/files for full details.

Remote tools

See Register remote tools for full details.

Error handling

Every method throws an AgentFlowError when the server returns a non-2xx response. AgentFlowError extends the built-in Error, so message and stack are available as usual, plus:

Two helper methods are available on every error:

import { AgentFlowError } from '@10xscale/agentflow-client';

try {
  const result = await client.invoke([userMessage]);
} catch (err) {
  if (err instanceof AgentFlowError) {
    console.error(`API error ${err.statusCode} (${err.errorCode}) request ${err.requestId}`);
    console.error(err.getUserMessage());
    logger.error(err.toJSON());
  } else {
    throw err;
  }
}

Error taxonomy

createErrorFromResponse() picks the most specific subclass it can. It matches errorCode first, then falls back to the HTTP status. Every class below extends AgentFlowError, so instanceof AgentFlowError always catches them.

Because errorCode is matched before the status, a GRAPH_RECURSION_ERROR returned with a 500 arrives as GraphRecursionError, not ServerError.

import {
  AgentFlowError,
  AuthenticationError,
  GraphRecursionError,
  TransientStorageError,
} from '@10xscale/agentflow-client';

try {
  await client.invoke([userMessage], { config: { thread_id: 'thread-1' } });
} catch (err) {
  if (err instanceof AuthenticationError) {
    redirectToLogin();
  } else if (err instanceof GraphRecursionError) {
    showError(`Run exceeded ${err.recursionLimit ?? 'the'} step limit.`);
  } else if (err instanceof TransientStorageError) {
    await retryWithBackoff();
  } else if (err instanceof AgentFlowError) {
    showError(err.getUserMessage());
  } else {
    throw err;
  }
}

Building errors yourself

Both helpers used internally are exported, which is useful when you proxy 10xGraph through your own server and want to re-raise the same error types on the far side.

import { createErrorFromResponse } from '@10xscale/agentflow-client';

const response = await fetch(`${base}/v1/graph/invoke`, init);
if (!response.ok) {
  throw await createErrorFromResponse(response, 'Invoke failed', '/v1/graph/invoke', 'POST');
}

What you learned

• AgentFlowClient is instantiated with a baseUrl and optional auth, headers, timeout, and debug options.
• Every API domain (invoke, stream, threads, memory, files, tools) is covered by a method on this class.
• Errors are thrown as AgentFlowError (or a specific subclass) carrying statusCode, errorCode, requestId, details, and a recoverySuggestion.

Next step

See how-to/client/create-client for a step-by-step guide to setting up and verifying the client, or jump to reference/client/invoke to learn the invoke() method in depth.