Observe.AI is an agentic AI platform for the contact center, providing purpose-built AI agents that handle customer support end-to-end across voice and chat, real-time AI Copilot guidance that assists frontline agents during live interactions, and Conversation Intelligence that evaluates every interaction for quality assurance, compliance, and business insight. Its AI agents connect to CRM, CCaaS, knowledge base, and backend systems to read and write data and trigger workflows, backed by 250+ prebuilt integrations and API/integration toolkits. Observe.AI serves regulated industries including banking and financial services, healthcare, insurance, and travel and hospitality, and maintains SOC 2, ISO 27001, and HIPAA compliance. Its public developer surface is the Reporting APIs at api-docs.observe.ai — an OpenAPI 3.0.1 contract covering asynchronous export of interactions, GenAI summaries, Auto QA and manual evaluations, coachings and ack/dispute state, plus a Data Subject Request deletion API and a scheduled bulk export to Snowflake or S3 described by sixteen JSON Schemas. The company was added to the API Evangelist network as a portfolio company of Scale Venture Partners and the SoftBank Vision Fund.
Observe.AI publishes 7 APIs on the APIs.io network, including Ack Dispute Flow API, Authentication API, Coachings API, and 4 more. Tagged areas include Company, Ai Apps, Contact Center, Conversation Intelligence, and Customer-Support.
Observe.AI’s developer surface includes engineering blog, support, documentation, API reference, getting-started guide, changelog, authentication, and 25 more developer resources.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/observeai: open an issue to ask a question, or submit a pull request to add artifacts.
Submit an artifact on GitHub — free →Manage your own listing — the Influence plan, $499/mo →
OAuth 2.0, which stands for “Open Authorization”, is a standard design to allow a website or application to access resources hosted by other web apps on behalf of a user Note...
Interactions API is an omnichannel API can be used to obtain all the data related to the interactions like Moments, Transcripts and metadata related to Interactions(including Vo...
aid: observeai
deliveryModel:
model: saas
open_source: false
commercial: true
callable_host: false
label: Hosted service · you call their endpoint
confidence: medium
source:
- openapi
- pricing
generated: '2026-08-28'
method: derived
accessModel:
pricing: contract
onboarding: sales-gated
trial: false
try_now: false
public: false
label: Sales-gated
confidence: high
source:
- https://api-docs.observe.ai/#tag/Authentication
- https://api-docs.observe.ai/#tag/ReportingService-Overview
- https://aws.amazon.com/marketplace/pp/prodview-q2xrm5ud6rkro
note: The API documentation is fully public, but access is not. App credentials are requested from help@observe.ai or a
CSM, and the tenant base URL is issued by support ticket, so nothing can be called without an existing contract.
generated: '2026-08-14'
method: searched
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/observeai.png
name: Observe.AI
description: Observe.AI is an agentic AI platform for the contact center, providing purpose-built AI agents that handle customer
support end-to-end across voice and chat, real-time AI Copilot guidance that assists frontline agents during live interactions,
and Conversation Intelligence that evaluates every interaction for quality assurance, compliance, and business insight.
Its AI agents connect to CRM, CCaaS, knowledge base, and backend systems to read and write data and trigger workflows, backed
by 250+ prebuilt integrations and API/integration toolkits. Observe.AI serves regulated industries including banking and
financial services, healthcare, insurance, and travel and hospitality, and maintains SOC 2, ISO 27001, and HIPAA compliance.
Its public developer surface is the Reporting APIs at api-docs.observe.ai — an OpenAPI 3.0.1 contract covering asynchronous
export of interactions, GenAI summaries, Auto QA and manual evaluations, coachings and ack/dispute state, plus a Data Subject
Request deletion API and a scheduled bulk export to Snowflake or S3 described by sixteen JSON Schemas. The company was added
to the API Evangelist network as a portfolio company of Scale Venture Partners and the SoftBank Vision Fund.
url: https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/apis.yml
x-type: company
x-source: vc-portfolio
x-backed-by:
- scale-venture-partners
- softbank-vision-fund
x-tier: enriched
x-tier-reason: published-openapi-harvested
specificationVersion: '0.23'
created: '2026-07-17'
modified: '2026-08-14'
tags:
- Company
- Ai Apps
- Contact Center
- Conversation Intelligence
- Customer-Support
- Agentic AI
- Voice AI
- Quality Assurance
- Reporting
- OpenAPI
- Speech Analytics
tags_raw:
- Company
- Ai Apps
- Contact Center
- Conversation Intelligence
- Customer Support
- Agentic AI
- Voice AI
- Quality Assurance
- Reporting
- OpenAPI
- Speech Analytics
apis:
- aid: observeai:observeai-ack-dispute-flow-api
name: Observe.AI Ack Dispute Flow API
description: "Ack Dispute API can be used to pull all evaluation related data which are sent for acknowledgment or dispute.\n\
\nPlease note -\n <ol>\n <li>Allow 24 hrs to pass before pulling Ack Dispute Data. ie., For Evaluations completed\
\ on\n14-Jan by 12:00AM PST, they would be available via APIs by 15-Jan by 12:00AM PST.</li>\n <li>You can pull Ack\
\ Dispute for 90 days at a time i.e., the duration between the end_date and\nthe start_date should not exceed 90 days.</li>\n\
\ <Li>There is no limit as to how far back in the past you want to go for pulling Ack Dispuet\nData. You can go back\
\ to the first ever evaluation on the platform unless data retention limits have been set.</li>\n <li>The S3 URL\
\ obtained in the API response (with the evaluations) is valid for 24 hours.\n </li>\n\
\ <li>If you have been using Basic Auth for the APIs, we request you to switch to OAuth2.0 based\nAuth for the APIs\
\ by 31-Dec-2022. Detailed instructions to create API Credentials and make the switch to OAuth are documented <a href=\"\
#tag/Authentication\">here</a>. Please reach out to your CSM for more details.</li>\n </ol>"
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- Ack Dispute Flow
properties:
- type: OpenAPI
url: openapi/observeai-ack-dispute-flow-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
- aid: observeai:observeai-authentication-api
name: Observe.AI Authentication API
description: "OAuth 2.0, which stands for “Open Authorization”, is a standard design to allow a website or application to\
\ access resources hosted by other web apps on behalf of a user\n\n<b>Note</b>: If you have been using Basic Auth for\
\ the APIs, we request you to switch to OAuth2.0 based Auth for the APIs by 31-Dec-2022. Detailed instructions to create\
\ API Credentials and make the switch to OAuth are documented as below. Please reach out to your CSM for more details.\n\
\n<h2> OAuth App Credential Flow </h2>\n\nThe App Credentials flow is recommended for server-side (AKA confidential) client\
\ applications with no end user, which normally describes machine-to-machine communication. Your application needs to\
\ securely store its app ID and secret and pass those to Observe Authentication Api in exchange for an access token.\n\
\n<h3> Steps required for generating access token </h3>\n\n 1. API Credential Generation:\n<ul>\n <li>To get access\
\ for API credentials, please contact help@observe.ai.</li>\n <li>AppId and AppSecret required to create access tokens,\
\ you can generate max of 3 apps.</li>\n\n - Select New App Id and App Secret.<br>\n\n <img src=\"https://cdn.observe.ai/apicredentials_generation.png\"\
/><br>\n\n - Add your app name.<br>\n\n <img src=\"https://cdn.observe.ai/apicredentials_appname.png\"/><br>\n\n\
\ - Download the credentials, <b>these can not viewed/downloaded later.</b><br>\n\n <img src=\"https://cdn.observe.ai/apicredentials_download.png\"\
/><br>\n</ul>\n 2. Access Token\n<ul>\n <li>You can create accessToken, using AppId and AppSecret from step 1.</li>\n\
\n <li><b>Access Token expires in 2 hrs, needs to be created again after expiry time.</b></li>\n\n <li>The 'Create\
\ Auth Token API' API has a rate limit of 1500 requests per day.</li>\n</ul>\n\n<li> The video in Getting Started outlines\
\ these steps in detail </li>"
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- Authentication
properties:
- type: OpenAPI
url: openapi/observeai-authentication-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
- aid: observeai:observeai-coachings-api
name: Observe.AI Coachings API
description: "Coachings API can be used to pull all the Coaching sessions done on Observe AI platform.\nPlease note -\n\
\ <ol>\n <li>Allow 24 hrs to pass before pulling Coaching sessions. ie., For Coaching sessions completed\non 14-Jan\
\ by 12:00AM PST, they would be available via APIs by 15-Jan by 12:00AM PST.</li>\n <li>You can pull Coaching sessions\
\ for 90 days at a time i.e., the duration between the end_date\nand the start_date should not exceed 90 days.</li>\n\
\ <Li>There is no limit as to how far back in the past you want to go for pulling Coaching sessions.\nYou can go back\
\ to the first ever coaching session on the platform unless data retention limits have been set.</li>\n <li> All the\
\ Coaching sessions that were Submitted, Edited and Deleted in the date-range will\nbe available in the API response.</li>\n\
\ <ul>\n <li>Lets take an example to explain it further - when you pull Coaching sessions for 15 days(say\n\
for start_date - 15-Jan and end_date 30-Jan) on 15-Feb via an API call, you get all Coaching sessions that were -</li>\n\
\ <ul>\n <li>submitted between 15-jan and 30-jan with \"status\": \"SUBMITTED\"</li>\n \
\ <li>submitted before 15-jan but modified/deleted between 15-jan and 30-jan with \"status\"=\"EDITED\"\n/ \"status\"\
=\"DELETED\"</li>\n <li>submitted between 15-jan and 30-jan but modified after 30-jan until the pull date(15-Feb)\n\
with \"status\"=\"EDITED\"</li>\n </ul>\n </ul>\n <li>The S3 URL obtained in the API response (with the\
\ coaching sessions) is valid for 24 hours.\n </li>\n <li>If you have been using Basic Auth for\
\ the APIs, we request you to switch to OAuth2.0 based\nAuth for the APIs by 31-Dec-2022. Detailed instructions to create\
\ API Credentials and make the switch to OAuth are documented <a href=\"#tag/Authentication\">here</a>. Please reach out\
\ to your CSM for more details.</li>\n </ol>"
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- Coachings
properties:
- type: OpenAPI
url: openapi/observeai-coachings-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
- aid: observeai:observeai-dsr-api
name: Observe.AI DSR API
description: 'DSR (Data Subject Request) deletion APIs allow customers to submit metadata-based deletion requests and check
the processing status of those requests.
<h3>Authentication</h3>
OAuth 2.0 Bearer Token is required. Use App ID and App Secret to generate a token via
<code>POST /v1/oauth/token</code>, then pass it as <code>Authorization: Bearer <auth_token></code>.
See <a href="#tag/Authentication">Authentication</a> for the full credential flow.'
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- DSR
properties:
- type: OpenAPI
url: openapi/observeai-dsr-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
- aid: observeai:observeai-evaluations-api
name: Observe.AI Evaluations API
description: "Evaluations API can be used to pull all the Evaluations(Manual and Auto QA) done on Observe AI platform.\n\
\nPlease note -\n <ol>\n <li>Allow 24 hrs to pass before pulling Evaluations. ie., For Evaluations completed on\
\ 14-Jan\nby 12:00AM PST, they would be available via APIs by 15-Jan by 12:00AM PST.</li>\n <li>You can pull Evaluations\
\ for 90 days at a time i.e., the duration between the end_date and\nthe start_date should not exceed 90 days.</li>\n\
\ <Li>There is no limit as to how far back in the past you want to go for pulling Evaluations.\nYou can go back to\
\ the first ever evaluation on the platform unless data retention limits have been set.</li>\n <li> All the Evaluations\
\ that were Submitted, Edited and Deleted in the date-range will be available\nin the API response.</li>\n <ul>\n\
\ <li>Lets take an example to explain it further - when you pull Evaluations for 15 days(say\nfor start_date\
\ - 15-Jan and end_date 30-Jan) on 15-Feb via an API call, you get all Evaluations that were -</li>\n <ul>\n\
\ <li>submitted between 15-jan and 30-jan with \"status\": \"SUBMITTED\"</li>\n <li>submitted\
\ before 15-jan but modified/deleted between 15-jan and 30-jan with \"status\"=\"EDITED\"\n/ \"status\"=\"DELETED\"</li>\n\
\ <li>submitted between 15-jan and 30-jan but modified after 30-jan until the pull date(15-Feb)\nwith \"\
status\"=\"EDITED\"</li>\n </ul>\n </ul>\n <li>The S3 URL obtained in the API response (with the\
\ evaluations) is valid for 24 hours.\n </li>\n <li>If you have been using Basic Auth\
\ for the APIs, we request you to switch to OAuth2.0 based\nAuth for the APIs by 31-Dec-2022. Detailed instructions to\
\ create API Credentials and make the switch to OAuth are documented <a href=\"#tag/Authentication\">here</a>. Please\
\ reach out to your CSM for more details.</li>\n </ol>"
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- Evaluations
properties:
- type: OpenAPI
url: openapi/observeai-evaluations-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
- aid: observeai:observeai-interactions-api
name: Observe.AI Interactions API
description: "Interactions API is an omnichannel API can be used to obtain all the data related to the interactions like\
\ Moments, Transcripts and metadata related to Interactions(including Voice calls and Web chat).\n\nPlease note -\n<ol>\n\
\ <li>Allow 24 hrs to pass before pulling Interactions. ie., For Interactions completed on 14-Jan\nby 12:00AM PST, they\
\ would be available via APIs by 15-Jan by 12:00AM PST.</li>\n <li>You can pull Interactions for 30 days at a time i.e.,\
\ the duration between the end_date and\nthe start_date should not exceed 30 days.</li>\n <li>There is no limit as to\
\ how far back in the past you want to go for pulling Interactions. You\ncan go back to the first ever evaluation on the\
\ platform unless data retention limits have been set.</li>\n <li>Interactions API gives a paginated response so the\
\ customer need to specify the page number\nand the desired amount of interactions in a page. By default, page_size is\
\ set to 100</li>\n <li>There is flexibility to either include or exclude Transcript in the API response by setting\n\
a query parameter includeTranscript. By default it is set to false.</li>\n <li>The S3 URL obtained in the API response\
\ (with the interactions) is valid for 24 hours.</li>\n <li>Clients using ‘Calls report API’ are requested to switch\
\ to ‘Interactions API’ which provides\nseveral benefits listed <a href=\"#tag/CallsReportVsInteractions\">here</a>. ‘Calls\
\ report API’ will be deprecated after 31-Dec-2022. Please reach out to your CSM for more details.</li>\n <li>If you\
\ have been using Basic Auth for the APIs, we request you to switch to OAuth2.0 based Auth\nfor the APIs by 31-Dec-2022.\
\ Detailed instructions to create API Credentials and make the switch to OAuth are documented <a href=\"#tag/Authentication\"\
>here</a>. Please reach out to your CSM for more details.</li>\n <li>If you need to pull Interactions by ID, there is\
\ a separate synchronous API - <a href=\"#tag/Interactions/operation/Get\nInteractions By Ids\">Get Interactions By Ids</a>.</li>\
\ </ol>"
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- Interactions
properties:
- type: OpenAPI
url: openapi/observeai-interactions-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
- aid: observeai:observeai-summary-api
name: Observe.AI Summary API
description: "Summarization AI API can be used to pull the data related to summaries for a particular interaction including\
\ calls and chats.\n\nPlease note -\n<ol>\n <li> Summaries can only be extracted if they are available for the interaction.</li>\n\
\ <li>Allow 24 hrs to pass before pulling summaries. ie., For summaries completed on 14-Jan by 12:00AM\nPST, they would\
\ be available via APIs by 15-Jan by 12:00AM PST.</li>\n <li>You can pull Summaries for 30 days at a time i.e., the duration\
\ between the end_date and the\nstart_date should not exceed 30 days.</li>\n <li>There is no limit as to how far back\
\ in the past you want to go for pulling summaries. You can\nretrieve summaries from the very first ones generated on\
\ the platform, unless data retention limits have been set.</li>\n <li>Summarization AI API gives a paginated response\
\ so the customer need to specify the page number\nand the desired amount of summaries in a page. By default, page_size\
\ is set to 100</li>\n <li>There is flexibility to either include or exclude Transcript in the API response by setting\n\
a query parameter includeTranscript. By default it is set to false.</li>\n <li>The S3 URL obtained in the API response\
\ (with the summaries) is valid for 24 hours.</li>\n <li>If you need to pull Summaries by ID, there is a separate synchronous\
\ API - <a href=\"#tag/Summary/operation/Get\nSummaries By Ids\">Get Summaries By Ids</a>.</li> </ol>"
humanURL: https://api-docs.observe.ai/
baseURL: https://kong.observe.ai/
tags:
- Summary
properties:
- type: OpenAPI
url: openapi/observeai-summary-api-openapi.yml
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/ReportingService-Overview
- type: Authentication
url: authentication/observeai-authentication.yml
- type: Conventions
url: conventions/observeai-conventions.yml
- type: RateLimits
url: rate-limits/observeai-rate-limits.yml
- type: ErrorCatalog
url: errors/observeai-problem-types.yml
- type: DataModel
url: data-model/observeai-data-model.yml
- type: ChangeLog
url: changelog/observeai-changelog.yml
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-coaching-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-team-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- type: JSONSchema
url: json-schema/observeai-bulk-export-user-v1.schema.json
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
- FN: APIs.json
email: info@apis.io
common:
- type: CapabilityMap
url: capabilities/observeai-capability-edges.yml
name: Observe.AI Business Capability Map
- type: Overlay
url: overlays/observeai-reporting-apis-overlay.yaml
- type: Website
url: https://www.observe.ai/
- type: Blog
url: https://www.observe.ai/blog
- type: Support
url: https://help.observe.ai/
- type: TermsOfService
url: https://www.observe.ai/terms
- type: PrivacyPolicy
url: https://www.observe.ai/privacy-policy
- type: GitHubOrganization
url: https://github.com/observeai
- type: Integrations
url: https://www.observe.ai/integrations
- type: StatusPage
url: https://status.observe.ai/
- type: Lifecycle
url: lifecycle/observeai-lifecycle.yml
- type: TrustCenter
url: security/observeai-trust-center.yml
- type: Compliance
url: https://www.observe.ai/trust
- type: VulnerabilityDisclosure
url: security/observeai-vulnerability-disclosure.yml
- type: Security
url: https://www.observe.ai/contact-center-security
- type: DomainSecurity
url: security/observeai-domain-security.yml
- type: DeveloperPortal
url: https://api-docs.observe.ai/
- type: Documentation
url: https://api-docs.observe.ai/
- type: APIReference
url: https://api-docs.observe.ai/
- type: GettingStarted
url: https://api-docs.observe.ai/#tag/Reporti
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/apis.yml
Kin Score
How this is scored →