Skip to main content

​
Welcome

The IrisAgent API lets you use IrisAgent as a service from your own application. You can power intelligent conversations and search, and index and connect your internal and external knowledge articles, tickets, community forums, product documentation, and other informational content. We follow the OpenAPI specification, and the full machine-readable definition is published alongside these docs.

IrisAgent API Specification

View the OpenAPI specification file

​
Base URL

All requests are made against:

​
Authentication

All API endpoints are authenticated using Bearer tokens, which are provided by your IrisAgent point of contact. Pass the token in the Authorization header on every request:
Treat the key as a secret. Send it from your backend rather than from browser or mobile client code, and rotate it through your IrisAgent contact if it is ever exposed.

​
What the API covers

The endpoints fall into three broad groups.

​
Asking and answering

  • POST /v1/irisgpt/ask returns a grounded answer to a customer or agent question
  • POST /v1/summary returns a summary
  • POST /v1/feedback records user feedback on an answer

​
Classification and analysis

  • POST /v1/tag returns an AI-generated tag for a ticket
  • POST /v1/sentiment returns sentiment for a ticket

​
Ingesting and searching content

  • POST /v1/articles uploads knowledge articles, and DELETE /v1/articles removes them
  • POST /v1/cases uploads support cases
  • POST /v1/incidents uploads incidents
  • POST /v1/search/cases searches across cases
  • GET /v1/community/search/articles searches articles
Full request and response schemas for each endpoint are in the API reference pages generated from the specification.

​
Choosing the API or an integration

The API is the right choice when your content or your support workflow lives in a system IrisAgent does not integrate with directly, or when you are embedding IrisAgent inside your own product surface. If your content already lives in a supported platform, a native integration is usually less work and stays in sync automatically. See Ticketing System KB, Public Websites, and Custom API for those options.