Proficient AI Documentation home pagelight logodark logo
  • GitHub
  • Request Access
  • Request Access
Client API
Specification
  • Documentation
  • Client API Reference
  • Admin API Reference
  • Community & Support
  • GitHub
  • Client API
    • Introduction
    • Authentication
    • Specification
    Agents
    • GET
      List all agents
    • GET
      Retrieve an agent
    Interactions
    • GET
      List all interactions
    • POST
      Create an interaction
    • GET
      Retrieve an interaction
    • POST
      Update an interaction
    • DEL
      Delete an interaction
    Messages
    • GET
      List all messages in an interaction
    • POST
      Create a message in an interaction
    • GET
      Retrieve a message
    • POST
      Ask for a reply to a message
    Users
    • GET
      Retrieve a user
    • POST
      Update a user
    Client API

    Specification

    Our Client API specification is defined in Fern, which is a more powerful alternative to OpenAPI. Fern definition allows us to produce fully type-safe code and brings a higher level of reliability to our systems. We also have an OpenAPI spec, which is generated by Fern.

    Fern Definition

    This is where we define the interface of the Client API that our entire architecture relies upon.

    OpenAPI Spec

    This is the Fern-generated OpenAPI (v3) specification for the Client API.

    AuthenticationList all agents
    discordgithubtwitterlinkedin
    Powered by Mintlify