APX

Core Concepts Overview

Understand the fundamental concepts that power the APX platform

concepts architecture

Architecture Overview

APX is built around four core concepts that work together to provide a powerful API testing and intelligence platform.

1. Projects

Projects are the top-level organizational unit in APX.

  • Container for related APIs and sessions
  • Team collaboration workspace
  • Isolated environment for testing
  • Version and change tracking

Use Cases

  • Separate different applications or microservices
  • Organize by team or department
  • Isolate staging vs. production testing

Learn more about Projects →

2. APIs

APIs represent the services you want to test and understand.

  • Registered with name, endpoint, and version
  • Each API can have multiple sessions
  • Independent agent management
  • Historical behavior tracking

Features

  • Auto-discovery of endpoints
  • Schema inference
  • Dependency mapping
  • Behavioral analysis

Learn more about APIs →

3. Sessions

Sessions are interactive testing conversations with your API.

  • Tab-based interface for multiple concurrent sessions
  • Real-time WebSocket communication
  • Mission profile-guided testing
  • Complete history and replay

Session Types

  • Active Sessions: Currently running tests
  • Past Sessions: Historical records you can review
  • Shared Sessions: Collaborative testing with team members

Learn more about Sessions →

4. Agents

Agents are intelligent assistants that help you test and understand your APIs.

  • One agent per API
  • Start/stop on demand
  • Mission profile execution
  • Real-time analysis and insights

Agent Capabilities

  • Endpoint discovery
  • Pattern recognition
  • Error detection
  • Behavior documentation

Learn more about Agents →

How They Work Together

Project
├── API 1
│   ├── Agent (running)
│   ├── Active Session 1 (Tab 1)
│   ├── Active Session 2 (Tab 2)
│   └── Past Sessions
└── API 2
    ├── Agent (stopped)
    └── Past Sessions

The APX Workflow

  1. Create a Project - Organize your work
  2. Add APIs - Register the services you want to test
  3. Start Agents - Activate intelligent testing assistants
  4. Create Sessions - Begin interactive testing
  5. Gather Insights - Discover behaviors and patterns
  6. Share Knowledge - Document and collaborate with team

Next Steps

Dive deeper into each concept:

Last updated: January 18, 2025