Charthop ai API

The ai API from Charthop — 17 operation(s) for ai.

Documentation Provider Profile APIs.io OpenAPI GitHub

Charthop ai API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ai. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 17 paths, and defines 33 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

24 operations 17 paths 33 schemas 3 DELETE7 GET3 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 2.0

API Version

V1.0.0

Base URL

https://api.charthop.com

Contact

ChartHop

Resource Areas

Paths & Operations 24

Across 17 paths, the API surfaces 24 operations — 3 DELETE, 7 GET, 3 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

ai 24

GET

/v1/org/{orgId}/ai/agent-memory

List memories for an agent

listMemories 4 params → 200401403

POST

/v1/org/{orgId}/ai/agent-memory

Create a new memory

createMemory 2 params → 201400401403

GET

/v1/org/{orgId}/ai/agent-memory/{memoryId}

Get a single memory

getMemory 2 params → 200401403404

PATCH

/v1/org/{orgId}/ai/agent-memory/{memoryId}

Update a memory

updateMemory 3 params → 204400401403404

DELETE

/v1/org/{orgId}/ai/agent-memory/{memoryId}

Delete a memory

deleteMemory 2 params → 204401403404

POST

/v1/org/{orgId}/ai/chat

Start a new AI chat with an initial message or question

startChat 2 params → 201400401403404

GET

/v1/org/{orgId}/ai/chat

Retrieve previous AI chats

findChats 9 params → 200400401403404

GET

/v1/org/{orgId}/ai/chat/prompt-suggest

Retrieve some suggested prompts for starting an AI chat

getSuggestedPrompts 2 params → 200400401403404

GET

/v1/org/{orgId}/ai/chat/top-users

Find users with the most AI chats over a date range

findTopUsers 7 params → 200400401403404

GET

/v1/org/{orgId}/ai/chat/{chatId}

Retrieve a previous AI chat

getChat 2 params → 200400401403404

PATCH

/v1/org/{orgId}/ai/chat/{chatId}

Update an existing AI chat's metadata, such as label or shareAccess information

updateChat 3 params → 204400401403404

DELETE

/v1/org/{orgId}/ai/chat/{chatId}

Delete an AI chat

deleteChat 2 params → 204401403404

POST

/v1/org/{orgId}/ai/chat/{chatId}/answer-tool

Answer a pending AskUserQuestion tool call in an AI chat

answerToolQuestion 3 params → 200400401403404

POST

/v1/org/{orgId}/ai/chat/{chatId}/approve-tool

Approve pending tool calls in an AI chat

approveToolUses 3 params → 200400401403404

POST

/v1/org/{orgId}/ai/chat/{chatId}/message

Send an additional message to an existing AI chat

sendMessageToChat 3 params → 201400401403404

GET

/v1/org/{orgId}/ai/chat/{chatId}/message/{messageId}

Retrieve an individual message from an existing AI chat

getChatMessage 3 params → 200400401403404

POST

/v1/org/{orgId}/ai/chat/{chatId}/message/{messageId}/feedback

Send feedback on a message in an AI chat

sendChatMessageFeedback 4 params → 204400401403404

POST

/v1/org/{orgId}/ai/chat/{chatId}/reject-tool

Reject pending tool calls in an AI chat

rejectToolUses 3 params → 200400401403404

PATCH

/v1/org/{orgId}/ai/config

Update configuration of AI models for this org (ChartHop staff only)

configureModelForOrg 2 params → 200400401403404

POST

/v1/org/{orgId}/ai/form-response/summary

Use AI to generate a summary of text form responses

summarizeFormResponses 2 params → 204400401403404

POST

/v1/org/{orgId}/ai/translate

Translate from one language to another using AI

translate 2 params → 204400401403404

POST

/v1/org/{orgId}/ai/translate/detect-language

Detect the dominant language of a text

detectLanguage 2 params → 200400401403404

POST

/v1/org/{orgId}/ai/translate/expression

Translate natural language into a CQL filter expression

translateExpression 2 params → 200400401403404

DELETE

/v1/org/{orgId}/ai/translate/expression

Invalidate all cached expression translation responses

invalidateExpressionTranslations 1 param → 204401403404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are AiChat (36 properties), AiChatMessage (16 properties), AiChatSummary (12 properties), AiChatRequest (10 properties). Each schema is shown below with its type and property counts.

AiSuggestedPromptsResponse

object

1 property 1 required

AiChatMessageBlock

object

5 properties

UpdateAiChat

object

2 properties

AiChatAnswerToolRequest

object

3 properties 2 required

AccessAction

object

3 properties 1 required

AiChat

object

36 properties 7 required

DetectLanguageResponse

object

1 property 1 required

AiTranslateResponse

object

1 property 1 required

AiTranslateRequest

object

3 properties 3 required

TabularData

object

5 properties 2 required

AiChatApproveToolRequest

object

1 property 1 required

AiExpressionTranslateRequest

object

1 property 1 required

AiToolResult

object

10 properties 2 required

AiChatMessage

object

16 properties 3 required

AiExpressionTranslateResponse

object

1 property 1 required

AiChatChannel

object

4 properties 1 required

ResultsAccess

object

2 properties 1 required

SummarizeFormResponsesRequest

object

5 properties 1 required

AiToolUse

object

6 properties 3 required

AiToolActionButton

object

3 properties 2 required

AiChatFeedback

object

1 property 1 required

AiChatSummary

object

12 properties 5 required

AiPromptConfig

object

3 properties 2 required

DetectLanguageRequest

object

1 property 1 required

UpdateAiAgentMemory

object

3 properties

AiChatRequest

object

10 properties 1 required

UpdateAiConfig

object

1 property

ResultsAiChat

object

3 properties 1 required

ShareAccess

object

4 properties 1 required

CreateAiAgentMemory

object

7 properties 2 required

SummarizeResponse

object

2 properties 2 required

AiChatRejectToolRequest

object

2 properties 1 required

AiToolEntity

object

4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Charthop publishes across the network.

Charthop access API

AE Profile APIs.io

Charthop action API

AE Profile APIs.io

Charthop ai-credit-limit API

AE Profile APIs.io

Charthop ai-hint API

AE Profile APIs.io

Charthop ai-prompt API

AE Profile APIs.io

Charthop app API

AE Profile APIs.io

Charthop appConfig API

AE Profile APIs.io

Charthop approval API

AE Profile APIs.io

Charthop approval-delegate API

AE Profile APIs.io

Charthop approval-request API

AE Profile APIs.io

Charthop assessment API

AE Profile APIs.io

Charthop band API

AE Profile APIs.io

#ai

← Back to C APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Charthop ai API

Metadata

Paths & Operations 24

Schemas 33

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Charthop ai API

Metadata

Paths & Operations 24

Schemas 33

Specification

Source

More from Charthop 12

API Details

Provider

Explore more