For AI agents: visit https://authenticx.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Authenticx
HomeGuidesRecipesAPI Reference
v1.0

Log InAuthenticx
API Reference
Log In
v1.0HomeGuidesRecipesAPI Reference

Overview

  • AcxAPI Overview
  • Tips for Traversing the AcxAPI
  • Swagger Documentation

Authentication

  • Retrieving an Access Token
  • Authorizing Requests

AcxApi

  • Conversational Data & Insights
    • Conversations
      • Gets a list of classifiersget
      • Get classifier results for conversations based on filter criteriaget
      • Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.post
    • Evaluations
      • Get Evaluationsget
      • Get Evaluations with their modulesget
    • Interactions (Deprecated)
      • Get Interactionget
      • Get Interactions based on filter criteriaget
      • Get Interactions based on filter criteria.post
    • Metadata
      • Get Metadataget
      • Post Metadatapost
      • Patch Metadatapatch
    • Pharmacovigilance (PV) Data Reconciliation
      • Get Receipts based on filter criteriaget
      • Get Model Results based on filter criteriaget
      • Get Model Results for one or more specific conversationsget
    • Transcriptions
      • Get Single Conversation Transcriptionsget
      • Get Batched Conversation Transcriptionspost
    • Workflows
      • Get Workflowsget
  • Conversation Uploads
    • TextMedia
      • Upload Text Mediapost
    • Media
      • Upload Mediapost
  • User & Access Management
    • Agent
      • Get All Agentsget
      • Get Agentget
      • Update Agentput
      • Create Agentpost
    • Hierarchy
      • Get All Hierarchiesget
      • Create Hierarchypost
      • Update Hierarchyput
    • Roles
      • Get All Rolesget
    • User
      • Get User By UserNameget
      • Get All Usersget
      • Get Userget
      • Update Userput
      • Create Userpost
    • UserHierarchy
      • Get All Hierarchy Permissions For Userget
      • Get Hierarchy Permissions For Userget
      • Update Hierarchy Permissions For Userput

AcxAPI (SCIM)

  • (Scim) ResourceTypes
    • Get All Resource Typesget
    • Get Resource Typeget
  • (Scim) Schemas
    • Get All Schemasget
    • Get Schemaget
  • (Scim) ServiceProviderConfig
    • Get Service Provider Configget
  • (Scim) Users
    • Get Usersget
    • Create Userpost
    • Get Userget
    • Delete Userdel
    • Update Userput
    • Patch Userpatch

AcxApi (Experimental)

  • (Scim) ResourceTypes
    • Get All Resource Typesget
    • Get Resource Typeget
  • (Scim) Schemas
    • Get All Schemasget
    • Get Schemaget
  • (Scim) ServiceProviderConfig
    • Get Service Provider Configget
  • (Scim) Users
    • Get Usersget
    • Create Userpost
    • Get Userget
    • Delete Userdel
    • Update Userput
    • Patch Userpatch
  • Agent
    • Get All Agentsget
    • Get Agentget
    • Update Agentput
    • Create Agentpost
  • Conversations
    • Gets a list of classifiersget
    • Get classifier results for conversations based on filter criteriaget
    • Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.post
    • Get Single Conversation Transcriptionsget
    • Get Batched Conversation Transcriptionspost
  • Evaluations
    • Get Evaluationsget
    • Get Evaluations with their modulesget
  • Hierarchy
    • Get All Hierarchiesget
    • Create Hierarchypost
    • Update Hierarchyput
  • Interactions (Deprecated)
    • Get Interactionget
    • Get Interactions based on filter criteriaget
    • Get Interactions based on filter criteria.post
  • Media
    • Upload Text Mediapost
    • Upload Mediapost
  • Metadata
    • Get Metadataget
    • Post Metadatapost
    • Patch Metadatapatch
  • ModelResults
    • Get Model Results for one or more specific conversationsget
    • Get Model Results based on filter criteriaget
  • Receipts
    • Get Receipts based on filter criteriaget
  • Roles
    • Get All Rolesget
  • User
    • Get User By UserNameget
    • Get Userget
    • Get All Usersget
    • Update Userput
    • Create Userpost
  • UserHierarchy
    • Get All Hierarchy Permissions For Userget
    • Get Hierarchy Permissions For Userget
    • Update Hierarchy Permissions For Userput
  • Workflows
    • Get Workflowsget

AcxApi Experimental

  • User
  • Agent
    • Create Agentpost
    • Get Agentget
    • Update Agentput
    • Get All Agentsget
  • Conversations
    • Gets a list of classifiersget
    • Get classifier results for conversations based on filter criteriaget
    • Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.post
    • Get Batched Conversation Transcriptionspost
    • Get Single Conversation Transcriptionsget
  • Evaluations
    • Get Evaluationsget
    • Get Evaluations with their modulesget
  • Hierarchy
    • Create Hierarchypost
    • Update Hierarchyput
    • Get All Hierarchiesget
  • Interactions
    • Get Interactions based on filter criteriaget
    • Get Interactions based on filter criteria.post
    • Get Interactionget
  • Media
    • Upload Mediapost
  • Metadata
    • Get Metadataget
    • Post Metadatapost
    • Patch Metadatapatch
  • ModelResults
    • Get Model Results based on filter criteriaget
    • Get Model Results for one or more specific conversationsget
  • Receipts
    • Get Receipts based on filter criteriaget
  • Roles
    • Get All Rolesget
  • (Scim) ResourceTypes
    • Get All Resource Typesget
    • Get Resource Typeget
  • (Scim) Schemas
    • Get All Schemasget
    • Get Schemaget
  • (Scim) ServiceProviderConfig
    • Get Service Provider Configget
  • (Scim) Users
    • Get Usersget
    • Create Userpost
    • Delete Userdel
    • Get Userget
    • Patch Userpatch
    • Update Userput
  • TextMedia
    • Upload Text Mediapost
  • User
    • Get User By UserNameget
    • Create Userpost
    • Get Userget
    • Update Userput
    • Get All Usersget
  • UserHierarchy
    • Get Hierarchy Permissions For Userget
    • Update Hierarchy Permissions For Userput
    • Get All Hierarchy Permissions For Userget
  • Workflows
    • Get Workflowsget
  • Agent
    • Create Agentpost
    • Get Agentget
    • Update Agentput
    • Get All Agentsget
  • Conversations
    • Gets a list of classifiersget
    • Get classifier results for conversations based on filter criteriaget
    • Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.post
    • Get Batched Conversation Transcriptionspost
    • Get Single Conversation Transcriptionsget
  • Evaluations
    • Get Evaluationsget
    • Get Evaluations with their modulesget
  • Hierarchy
    • Create Hierarchypost
    • Update Hierarchyput
    • Get All Hierarchiesget
  • Interactions
    • Get Interactions based on filter criteriaget
    • Get Interactions based on filter criteria.post
    • Get Interactionget
  • Media
    • Upload Mediapost
  • Metadata
    • Get Metadataget
    • Post Metadatapost
    • Patch Metadatapatch
  • ModelResults
    • Get Model Results based on filter criteriaget
    • Get Model Results for one or more specific conversationsget
  • Receipts
    • Get Receipts based on filter criteriaget
  • Roles
    • Get All Rolesget
  • (Scim) ResourceTypes
    • Get All Resource Typesget
    • Get Resource Typeget
  • (Scim) Schemas
    • Get All Schemasget
    • Get Schemaget
  • (Scim) ServiceProviderConfig
    • Get Service Provider Configget
  • (Scim) Users
    • Get Usersget
    • Create Userpost
    • Delete Userdel
    • Get Userget
    • Patch Userpatch
    • Update Userput
  • TextMedia
    • Upload Text Mediapost
  • User
    • Get User By UserNameget
    • Create Userpost
    • Get Userget
    • Update Userput
    • Get All Usersget
  • UserHierarchy
    • Get Hierarchy Permissions For Userget
    • Update Hierarchy Permissions For Userput
    • Get All Hierarchy Permissions For Userget
  • Workflows
    • Get Workflowsget
Powered by 

User

Updated 11 days ago


Get Workflows
Agent
Did this page help you?

Updated 11 days ago


Get Workflows
Agent
Did this page help you?