Proficient AI Documentation home pagelight logodark logo
  • GitHub
  • Request Access
  • Request Access
Admin API
Specification
  • Documentation
  • Client API Reference
  • Admin API Reference
  • Community & Support
  • GitHub
  • Admin API
    • Introduction
    • Authentication
    • Specification
    Agents
    • GET
      List all agents
    • POST
      Create an agent
    • GET
      Retrieve an agent
    • POST
      Update an agent
    • DEL
      Delete an agent
    • GET
      Retrieve agent configuration
    • POST
      Update agent configuration
    • POST
      Activate an agent
    • POST
      Deactivate an agent
    Users
    • GET
      List all users
    • POST
      Create a user
    • GET
      Retrieve a user
    • POST
      Update a user
    • DEL
      Delete a user
    Admin API

    Specification

    Our Admin 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 Admin API that our entire architecture relies upon.

    OpenAPI Spec

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

    AuthenticationList all agents
    discordgithubtwitterlinkedin
    Powered by Mintlify