# Observe.AI Authentication API

**Canonical:** https://apis.io/apis/observeai/observeai-authentication-api/  
**Provider:** Observe.AI — https://apis.io/providers/observeai/  
**Base URL:** https://kong.observe.ai/  
**Documentation:** https://api-docs.observe.ai/

Observe.AI Authentication API is one of 7 APIs that [Observe.AI](https://apis.io/providers/observeai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 16 JSON Schema definitions. Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, rate-limit docs, and 16 JSON Schemas.

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 <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. <h2> OAuth App Credential Flow </h2> The 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. <h3> Steps required for generating access token </h3> 1. API Credential Generation: <ul> <li>To get access for API credentials, please contact help@observe.ai.</li> <li>AppId and AppSecret required to create access tokens, you can generate max of 3 apps.</li> - Select New App Id and App Secret.<br> <img src="https://cdn.observe.ai/apicredentials_generation.png"/><br> - Add your app name.<br> <img src="https://cdn.observe.ai/apicredentials_appname.png"/><br> - Download the credentials, <b>these can not viewed/downloaded later.</b><br> <img src="https://cdn.observe.ai/apicredentials_download.png"/><br> </ul> 2. Access Token <ul> <li>You can create accessToken, using AppId and AppSecret from step 1.</li> <li><b>Access Token expires in 2 hrs, needs to be created again after expiry time.</b></li> <li>The 'Create Auth Token API' API has a rate limit of 1500 requests per day.</li> </ul> <li> The video in Getting Started outlines these steps in detail </li>

## Machine-readable artifacts (26)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/openapi/observeai-authentication-api-openapi.yml
- **Documentation** — https://api-docs.observe.ai/
- **APIReference** — https://api-docs.observe.ai/
- **GettingStarted** — https://api-docs.observe.ai/#tag/ReportingService-Overview
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/authentication/observeai-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/conventions/observeai-conventions.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/rate-limits/observeai-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/errors/observeai-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/data-model/observeai-data-model.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/changelog/observeai-changelog.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-interaction-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-coaching-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-interaction-summary-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-audit-assignment-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-contact-reason-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-evaluation-template-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-team-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-user-login-activity-v1.schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-user-v1.schema.json

## Other Observe.AI APIs (6)

- [Observe.AI Ack Dispute Flow API](https://apis.io/apis/observeai/observeai-ack-dispute-flow-api/)
- [Observe.AI Coachings API](https://apis.io/apis/observeai/observeai-coachings-api/)
- [Observe.AI DSR API](https://apis.io/apis/observeai/observeai-dsr-api/)
- [Observe.AI Evaluations API](https://apis.io/apis/observeai/observeai-evaluations-api/)
- [Observe.AI Interactions API](https://apis.io/apis/observeai/observeai-interactions-api/)
- [Observe.AI Summary API](https://apis.io/apis/observeai/observeai-summary-api/)

## Tags

Authentication

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/observeai/observeai-authentication-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/observeai/.