Skip to main content
Use the IrisAgent API to add AI answers and search to your own app, and to send IrisAgent your articles, tickets, and other content.

IrisAgent API Specification

View the OpenAPI specification file

​
Base URL

​
Authentication

Send your API key as a Bearer token on every request:
Your key is the Business ID under Deploy → API Keys in the IrisAgent dashboard. Your IrisAgent contact can also provide it. Keep the key secret. Call the API from your backend, not from browser or mobile code. If the key is exposed, regenerate it on the API Keys page.

​
Endpoints

Ask and answer
  • POST /v1/irisgpt/ask: grounded answer to a customer or agent question
  • POST /v1/summary: summary
  • POST /v1/feedback: record feedback on an answer
Classify
  • POST /v1/tag: AI tag for a ticket
  • POST /v1/sentiment: sentiment for a ticket
Ingest and search
  • POST /v1/articles uploads articles; DELETE /v1/articles removes them
  • POST /v1/cases: upload support cases
  • POST /v1/incidents: upload incidents
  • POST /v1/search/cases: search cases
  • GET /v1/community/search/articles: search articles
Request and response schemas are on each endpoint’s reference page.

​
API or integration?

Use the API when your content or workflow lives in a system IrisAgent doesn’t integrate with, or when you embed IrisAgent in your own product. If your content is already in a supported platform, a native integration is less work and syncs automatically. See Ticketing System KB, Public Websites, and Custom API.