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

Home Guides Recipes API Reference

v1.0

API Reference

v1.0Home Guides Recipes API Reference

Overview

AcxAPI Overview
Tips for Traversing the AcxAPI
Swagger Documentation

Authentication

Retrieving an Access Token
Authorizing Requests

AcxApi

Conversational Data & Insights
Conversation Uploads
- TextMedia
  - Upload Text Mediapost
- Media
  - Upload Mediapost
User & Access Management

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

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
Agent
Conversations
Evaluations
- Get Evaluationsget
- Get Evaluations with their modulesget
Hierarchy
Interactions (Deprecated)
Media
- Upload Text Mediapost
- Upload Mediapost
Metadata
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
UserHierarchy
Workflows
- Get Workflowsget

AcxApi Experimental

User
Agent
Conversations
Evaluations
- Get Evaluationsget
- Get Evaluations with their modulesget
Hierarchy
Interactions
Media
- Upload Mediapost
Metadata
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
TextMedia
- Upload Text Mediapost
User
UserHierarchy
Workflows
- Get Workflowsget
Agent
Conversations
Evaluations
- Get Evaluationsget
- Get Evaluations with their modulesget
Hierarchy
Interactions
Media
- Upload Mediapost
Metadata
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
TextMedia
- Upload Text Mediapost
User
UserHierarchy
Workflows
- Get Workflowsget

Powered by

Swagger Documentation

Authenticx also provides swagger documentation available here

Updated 4 months ago

Tips for Traversing the AcxAPI

Retrieving an Access Token

Did this page help you?

Updated 4 months ago

Tips for Traversing the AcxAPI

Retrieving an Access Token

Did this page help you?