How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CloudQuery chat API

The chat API from CloudQuery — 7 operation(s) for chat.

CloudQuery chat API is one of 26 APIs that CloudQuery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 7 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudquery.io.

11 operations 7 paths 19 schemas 1 DELETE4 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cloudquery.io
Authentication
HTTP Bearer, HTTP Basic, HTTP Cookie
License
Terms of Service
Resource Areas
1

Authentication & Security 3

CloudQuery chat API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). It uses HTTP cookie authentication (cookieAuth). By default, every request must be authenticated.

Paths & Operations 11

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

chat 11
POST
/agent-chat
Send a message to the AI agent orchestrator
PlatformAgentChat body → 200400401404429500
GET
/agent-chat/{session_id}
Get the persisted history of an agent conversation session
PlatformGetAgentChatSession 1 param → 200401404500
GET
/agent/custom-contexts
List custom contexts for the current tenant
PlatformListAgentCustomContexts → 200401403500
POST
/agent/custom-contexts
Create a new custom context for the agent
PlatformCreateAgentCustomContext body → 201400401403409500
GET
/agent/custom-contexts/{agent_custom_context_id}
Get a custom context by ID
PlatformGetAgentCustomContext 1 param → 200401403404500
PUT
/agent/custom-contexts/{agent_custom_context_id}
Update a custom context
PlatformUpdateAgentCustomContext 1 param body → 200400401403404409500
DELETE
/agent/custom-contexts/{agent_custom_context_id}
Delete a custom context
PlatformDeleteAgentCustomContext 1 param → 204401403404500
PATCH
/agent/custom-contexts/{agent_custom_context_id}/toggle-auto-include
Toggle a custom context's autoinclude flag
PlatformToggleAgentCustomContextAutoInclude 1 param → 200401403404500
POST
/conversations
Start a new chat conversation
PlatformCreateConversation body → 201400401429500
GET
/conversations/{conversation_id}
Retrieve a chat conversation
PlatformGetConversation 1 param → 200400401404422500
POST
/conversations/{conversation_id}
Add a message to an existing conversation
PlatformSendMessage 1 param body → 201400401403404422500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are PlatformAgentChatSessionTurn (11 properties), PlatformAgentChatResponse (9 properties), PlatformConversationMessage (8 properties), PlatformAgentChatPlanStep (6 properties). Each schema is shown below with its type and property counts.

PlatformAgentCustomContextUpdate
object
3 properties 3 required
PlatformConversationSendMessage
object
Send a message in a conversation
3 properties 1 required
PlatformAgentChatOutputType
string
The data type of an agent chat output. Determines which payload field is populated on AgentChatOutput and how the frontend should render the value. - query — S…
PlatformAgentCustomContextCreate
object
3 properties 2 required
PlatformAgentChatPlanStep
object
A single step in the agent orchestrator's execution plan.
6 properties
PlatformConversationCreate
object
3 properties 1 required
PlatformAgentChatExecutionPlan
object
The agent orchestrator's execution plan, assembled from the tool-use trajectory.
1 property
PlatformAgentChatStepResult
object
Outcome of executing a single plan step.
5 properties
PlatformConversationMessage
object
8 properties 7 required
PlatformAgentChatSessionTurn
object
A single persisted turn in an agent conversation session.
11 properties 3 required
PlatformAgentCustomContext
object
6 properties 6 required
PlatformAgentChatResponse
object
9 properties 4 required
PlatformFieldError
PlatformAgentCustomContextID
string
The unique ID for the agent custom context.
PlatformBasicError
object
Basic Error
2 properties 2 required
PlatformAgentChatSessionHistory
object
The persisted history of an agent conversation session.
2 properties 2 required
PlatformConversation
object
5 properties 4 required
PlatformAgentChatOutput
object
A single structured output returned by an agent step. The type field determines which of datastr / dataobj is populated and how the frontend should render the…
3 properties 1 required
PlatformAgentChatRequest
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudquery-chat-api-openapi.yml Raw ↑

Other APIs CloudQuery publishes across the network.

CloudQuery Platform API
CloudQuery admin API
CloudQuery alerts API
CloudQuery api-keys API
CloudQuery apps API
CloudQuery audit-logs API
CloudQuery custom-columns API
CloudQuery filters API
CloudQuery healthcheck API
CloudQuery insights API
CloudQuery notifications API
CloudQuery onboardings API
Where this information came from

This is an independent, third-party profile of CloudQuery chat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.