Human 2 Human API - Typescript

api (1.0.0)

Getting Started

Example Client Initialization

import Client from "api_ts";

const client = new Client({
  apiKey: process.env["API_KEY"]!!,
  token: process.env["API_TOKEN"]!!,
});

Module Documentation and Snippets

agent

• create - Run an agent
• create_1 - Run a custom agent
• list - Get agent chat data

agent.abort

• create - Abort an in-progress agent chat

agent.chat

• delete - Delete an agent chat session
• patch - Update an agent chat session

agent.history

• list - List agent chat history

auth.login

• create - Log in

auth.refresh

• create - Refresh an auth token

chats

• get - Get a chat

datastore

• create - Create a datastore
• get - Get a datastore
• list - List datastores

datastore.items

• create - Create a datastore item
• delete - Delete a datastore item
• get - Get a datastore item
• list - List datastore items

datastore.query

• create - Query a datastore

feeds

• create - Create a new feed
• get - Get a specific feed by ID
• list - List all feeds

feeds.items

• create - Create a new feed item for an API feed
• get - Get a specific feed item by ID

integrations.api

• create - Create a new API integration
• delete - Delete an API integration
• get - Get an API integration by ID

integrations.api.operations

• create - Create a new API operation
• delete - Delete an API operation
• get - Get an API operation by ID
• patch - Update an API operation

integrations.api.secrets

• create - Create a new API secret
• delete - Delete an API secret
• list - Get all API secrets for an API integration

memory.tables

• create - Create a memory table
• delete - Delete a memory table
• get - Get a memory table
• list - List memory tables

memory.tables.mutate

• create - Mutate a memory table

memory.tables.query

• create - Query a memory table

searchGroups

• create - Create a new dictionary
• get - Get a search group by id
• list - List search groups

searchGroups.items

• create - Create a new search item in a search group
• get - Get a search item by id
• list - List search items in a search group

subscriptions.events

• create - Create an event subscription
• delete - Delete an event subscription
• get - Get an event subscription
• list - List event subscriptions

tools

• list - List tools

tools.codeExecution

• create - Execute code

tools.datastore

• create - Datastore tool

tools.dictionarySearch

• create - Search dictionary definitions

tools.format

• create - Format content

tools.internetSearch

• create - Run internet search

tools.memoryQuery

• create - Query memory

tools.metaTagger

• create - Apply meta tags

tools.sendEmail

• create - Send an email

tools.standardLlm

• create - Run standard LLM

tools.structuredOutput

• create - Generate structured output

workflows

• create - Create a workflow
• delete - Delete a workflow
• get - Get a workflow
• list - List workflows
• patch - Update a workflow origin

workflows.dispatch

• create - Dispatch a workflow

workflows.invoke

• create - Invoke a workflow

workflows.runs

• create - Create a workflow run
• delete - Delete a workflow run
• get - Get a workflow run
• list - List workflow runs

workflows.runs.dispatch

• create - Dispatch a workflow run

workflows.versions

• create - Create a new version of a workflow
• delete - Delete a workflow version
• get - Get a workflow version
• patch - Update a workflow version

workflows.versions.automation

• patch - Update automation artifacts for a workflow version

workflows.versions.tasks

• create - Create a workflow task
• delete - Delete a workflow task
• get - Get a workflow task
• patch - Update a workflow task

workspace.variables

• create - Create a workspace variable
• delete - Delete a workspace variable
• list - List workspace variables
• patch - Update a workspace variable