Class ArqeraClient

Arqera JavaScript/TypeScript SDK Client

Example:

import { ArqeraClient } from '@arqera/sdk';

const client = new ArqeraClient({ apiKey: 'arq_...' });
const tasks = await client.work.listTasks({ status: 'todo' });
const response = await client.ara.chat([{ role: 'user', content: 'Hello' }]);

Constructors

constructor

Properties

agents apiKey ara baseUrl events timeout work

Methods

execute listWorkspaces request

Constructors

constructor

Properties

agents

agents: AgentsModule

Private apiKey

apiKey: string

ara

ara: AraModule

Private baseUrl

baseUrl: string

events

events: EventsModule

Private timeout

timeout: number

work

work: WorkModule

Methods

execute

  • execute(payload): Promise<unknown>

  • Execute an Arqera workflow or action

    Parameters

    • payload: Record<string, unknown>

    Returns Promise<unknown>

listWorkspaces

  • listWorkspaces(): Promise<unknown>

  • List all workspaces available to the authenticated user

    Returns Promise<unknown>

request

  • request(path, init?): Promise<unknown>

  • Make an HTTP request to the Arqera API

    Parameters

    Returns Promise<unknown>

Settings

Member Visibility

Theme

On This Page

constructoragentsapiKeyarabaseUrleventstimeoutworkexecutelistWorkspacesrequest