Skip to main content

API Reference Overview

Welcome to the Agentrix API Reference documentation. This section provides comprehensive information about integrating with Agentrix APIs.

Introduction​

Agentrix provides a RESTful API that enables developers to programmatically interact with the platform. You can create tasks, manage share links, and integrate Agentrix capabilities into your applications.

Base URL​

https://api.xmz.ai/v1/

Authentication​

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Getting Your API Key​

  1. Log in to the Agentrix platform
  2. Navigate to Settings > API Keys
  3. Generate a new API key
  4. Store it securely - it will only be shown once

Request Format​

All POST and PUT requests should use JSON format with the appropriate Content-Type header:

Content-Type: application/json

Response Format​

All API responses are returned in JSON format. Successful responses return data directly without a wrapper structure.

Success Response​

Responses are returned directly with their specific data:

{
  //...response fields
}

Error Response​

Error responses include HTTP status codes (400, 401, 403, 404, 500) with error details:

{
  "code": "ERROR_CODE",
  "error": "error_type",
  "message": "Human-readable error message"
}

HTTP Status Codes​

Status CodeDescription
200Success - Request completed successfully
201Created - Resource created successfully
400Bad Request - Invalid request parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource not found
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Server error

Available Endpoints​

Chats​

  • Create Chat - Create a chat session with agents (required before creating tasks)

Tasks​

Support​

For API support and questions:

Changelog​

Track API changes and updates:

  • v1.0.0 (2026-01-21): Initial API release