Chat

Manage chat conversations, messages, and prompts.

GET

Get chat conversation with paginated messages

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/conversations/{conversationId}

Parameters

cursor: query · string
cursorId: query · string
direction: query · union
limit: query · number
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
conversationIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7
8const { conversation } = await gc.chat.getChatConversation({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  appId: "app-id",12  conversationId: "conversation-id",13});14

POST

Reply into a chat conversation as a human operator

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/conversations/{conversationId}/reply

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
conversationIdRequired: path · string

BodyRequired

contentRequired: string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: organizations[0].id });7
8const result = await gc.chat.replyToChatConversation({9  organizationId: organizations[0].id,10  projectId: projects[0].id,11  appId: "YOUR_APP_ID",12  conversationId: "YOUR_CONVERSATION_ID",13  data: {14    message: "Hello, how can I help you today?"15  }16});17

POST

Take over a chat conversation from the AI

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/conversations/{conversationId}/takeover

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
conversationIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { conversations } = await gc.chat.listChatConversations({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const result = await gc.chat.takeOverChatConversation({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  conversationId: conversations[0].id,22});23

DELETE

Release a chat conversation back to the AI

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/conversations/{conversationId}/takeover

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
conversationIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { conversations } = await gc.chat.listChatConversations({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const result = await gc.chat.releaseChatConversation({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  conversationId: conversations[0].id,22});23

GET

The visitor's trail behind a conversation, newest first

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/conversations/{conversationId}/timeline

Parameters

page: query · number
pageSize: query · number
lite: query · string
limit: query · integer
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
conversationIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { conversations } = await gc.chat.listChatConversations({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const timeline = await gc.chat.getChatConversationTimeline({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  conversationId: conversations[0].id,22});23

GET

List every visitor conversation in a chat app, most recently updated first

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/conversations

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
visitorId: query · string
userId: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { conversations } = await gc.chat.listChatConversations({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

GET

List every escalation in a chat app, newest first

/organizations/{organizationId}/projects/{projectId}/apps/chat/{appId}/escalations

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
status: query · string
visitorEmail: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { escalations } = await gc.chat.listChatEscalations({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

BuiltAutonomously With AI

This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Giant Context staff accepted and published.