Skip to content
Abi Global HealthAbi Global HealthAbi Docs

Overview

REST API 1.0.0

Section titled “REST API 1.0.0”

Manage user access, subscriptions, consultations, Health Navigator, prescriptions, and webhooks. Abi provides the base URL and credentials for each partner environment.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/partner/authorization/token
POST
/partner/authorization/token/refresh
POST
/user
GET
/user/{userId}
PUT
/user/{userId}
GET
/user/search
POST
/user/search
POST
/user/{userId}/subscription
GET
/user/{userId}/subscription/{subscriptionId}
DELETE
/user/{userId}/subscription/{subscriptionId}
GET
/user/{userId}/subscriptions
DELETE
/user/{userId}/subscriptions
GET
/user/{userId}/subscription/{subscriptionId}/history
PATCH
/user/{userId}/subscription/{subscriptionId}/history/cancel
POST
/consultation
GET
/consultation/{consultationId}
POST
/consultation/{consultationId}
GET
/consultation/{consultationId}/ai-summary
PATCH
/consultation/{consultationId}/cancel
PATCH
/consultation/{consultationId}/close
GET
/user/{userId}/case-history
GET
/v2/health-navigator/users/{userId}/conversations
POST
/v2/health-navigator/users/{userId}/conversations
POST
/v2/health-navigator/messages
GET
/v2/health-navigator/messages/{messageId}
GET
/v2/health-navigator/conversations/{conversationId}
PATCH
/v2/health-navigator/conversations/close
POST
/prescription
GET
/prescription/{prescriptionId}
PATCH
/prescription/{prescriptionId}/cancel
PATCH
/prescription/{prescriptionId}/close
GET
/prescription/survey/{lang}
GET
/prescription/survey/{lang}/{idIndicationSurvey}
GET
/prescription/survey/{idIndicationSurvey}/template
POST
/prescription/survey/validate
GET
/webhook
POST
/webhook
PATCH
/webhook/event/{name}/unsubscribe
POST
/webhook/format-event

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Security scheme type: http

apiKeyAuth

Section titled “apiKeyAuth”

Partner API key used to request an access token.

Security scheme type: apiKey

Header parameter name: x-api-key