Skip to content

API Reference

Complete reference for the Vexly API.

Overview

The Vexly API provides programmatic access to all platform features. The API is:

  • RESTful - Uses standard HTTP methods
  • JSON-based - All requests and responses use JSON
  • Authenticated - Requires API key authentication
  • Versioned - Supports multiple API versions

Base URL

https://api.agentspot.com/v1

Authentication

All API requests require authentication using an API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.agentspot.com/v1/agents

Common Endpoints

Agents

List Agents

GET /agents

Returns a list of all agents.

Create Agent

POST /agents

Creates a new agent.

Request Body: 

{
  "name": "MyAgent",
  "description": "Agent description",
  "config": {
    "model": "gpt-4",
    "temperature": 0.7
  }
}

Get Agent

GET /agents/{agent_id}

Retrieves details for a specific agent.

Update Agent

PUT /agents/{agent_id}

Updates an existing agent.

Delete Agent

DELETE /agents/{agent_id}

Deletes an agent.

Analytics

Get Usage Metrics

GET /analytics/usage

Returns usage statistics for your agents.

Query Parameters: - start_date - Start date (ISO 8601) - end_date - End date (ISO 8601) - agent_id - Filter by specific agent (optional)

Response Codes

  • 200 OK - Request successful
  • 201 Created - Resource created successfully
  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Missing or invalid API key
  • 404 Not Found - Resource not found
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server error

Rate Limiting

API requests are rate limited to:

  • 1000 requests per hour for standard tier
  • 10000 requests per hour for premium tier

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640000000

Error Handling

Error responses include details to help diagnose issues:

{
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "The 'name' parameter is required",
    "details": {
      "parameter": "name"
    }
  }
}

SDK Libraries

Official SDKs are available for:

  • Python: pip install agentspot-sdk
  • JavaScript: npm install @agentspot/sdk
  • Go: go get github.com/agentspot/go-sdk

Examples

Python

from agentspot import VexlyClient

client = VexlyClient(api_key="YOUR_API_KEY")

# List agents
agents = client.agents.list()

# Create agent
agent = client.agents.create(
    name="MyAgent",
    config={"model": "gpt-4"}
)

JavaScript

const Vexly = require('@agentspot/sdk');

const client = new Vexly({ apiKey: 'YOUR_API_KEY' });

// List agents
const agents = await client.agents.list();

// Create agent
const agent = await client.agents.create({
  name: 'MyAgent',
  config: { model: 'gpt-4' }
});

Support

For API support:

  • Email: api-support@agentspot.com
  • Documentation: https://docs.agentspot.com
  • Status: https://status.agentspot.com