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

ServiceChannel AIAgents API

The AIAgents API from ServiceChannel — 9 operation(s) for aiagents.

ServiceChannel AIAgents API is one of 66 APIs that ServiceChannel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 9 operations across 9 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version bearer.v1.

Requests are made against a single base URL, https://sb2fixxbook.servicechannel.com:443/api.

9 operations 9 paths 10 schemas 1 DELETE3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
bearer.v1
Base URL
https://api.servicechannel.com/v3
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ServiceChannel AIAgents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • oauth2 — OAuth2 Authorization

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

AIAgents 9
GET
/aiagents/locations/{locationId}/InitConversation
Initializes a new conversation with the necessary setup by creating and configuring the required resources for interaction.
GETv3_aiagents_locations_{locationId}_InitConversation?setupId={setupId} 2 params → 200400401403500
POST
/aiagents/SendMessage
Sends a message to the specified thread. This method ensures that the message is delivered according to the provided parameters, including thread and message data.
POSTv3_aiagents_SendMessage?threadId={threadId}&message={message} 2 params → 200400401500
POST
/aiagents/SendImage
Sends an image to the specified thread. This method ensures that the image content is delivered according to the provided parameters, including thread and image data.
POSTv3_aiagents_SendImage?threadId={threadId}&setupId={setupId} 2 params body → 200401500
GET
/aiagents/locations/{locationId}/ProcessMessageStream
Retrieves a stream of messages for a specific thread. This method establishes and manages a stream to receive continuous messages.
GETv3_aiagents_locations_{locationId}_ProcessMessageStream?setupId={setupId}&threadId={threadId}&assistantId={assistantId}&enableMetrics={enableMetrics} 5 params → 200401
DELETE
/aiagents/DeleteConversation
Deletes a specific conversation from the system. This method removes the conversation and all its associated data permanently.
DELETEv3_aiagents_DeleteConversation?threadId={threadId} 1 param → 200400401
POST
/aiagents/CreateConversation
Creates a new conversation instance
POSTv3_aiagents_CreateConversation → 201400401
GET
/aiagents/ProblemDescription
Retrieves the description of a specific problem based on the provided issue choice.
GETv3_aiagents_ProblemDescription?threadId={threadId}&assistantId={assistantId}&enableMetrics={enableMetrics} 3 params → 200400401403500
POST
/aiagents/CreateFeedbackSession
Creates a new feedback session for a specific conversation and AI agent
POSTv3_aiagents_CreateFeedbackSession body → 200400401403500
POST
/aiagents/AddFeedback
Add a new feedback to exist session for a specific conversation and AI agent
POSTv3_aiagents_AddFeedback body → 200400401403500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiAddFeedbackRequest (9 properties), ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiCreateFeedbackSessionRequest (9 properties), ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse (8 properties), ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackEntryResponse (6 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Api.Model.Dashboard.Assistant.UsageTokens
object
3 properties
ServiceChannel.Services.Messaging.AzureOpenAI.Assistant.ChatSessionModel
object
3 properties
ServiceChannel.Api.Model.Dashboard.Assistant.AssistantResponse_System.String
object
2 properties
ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackEntryResponse
object
6 properties
System.Object
object
ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse
object
8 properties
ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiCreateFeedbackSessionRequest
object
Model for first step of creating a feedback session, which is to create the session and return the session id. The session id will be used for adding feedbacks…
9 properties 3 required
ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiAddFeedbackRequest
object
Model for adding feedback to an existing WoAI feedback session.
9 properties 3 required
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Api.Model.Dashboard.Assistant.AssistantMetrics
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-aiagents-api-openapi.yml Raw ↑

Other APIs ServiceChannel publishes across the network.

ServiceChannel AfterHours API
ServiceChannel Announcements API
ServiceChannel ApplicationAccess API
ServiceChannel Assets API
ServiceChannel AssetTaskResponse API
ServiceChannel AssetTypes API
ServiceChannel Attachments API
ServiceChannel BatchRfp API
ServiceChannel Branding API
ServiceChannel Categories API
ServiceChannel CheckLists API
ServiceChannel Classification API
Where this information came from

This is an independent, third-party profile of ServiceChannel AIAgents 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.