API Reference

The Reminix API allows you to interact with your agents programmatically. All API endpoints are RESTful and return JSON responses.

Base URL

All API requests should be made to:

https://api.reminix.com/v1

Authentication

The Reminix API uses API keys for authentication. Include your API key in the Authorization header:

Authentication Header:

$ Authorization: Bearer YOUR_API_KEY

shell

💡 Info
You can find your API key in your Dashboard Settings.

Rate Limits

API requests are rate limited to prevent abuse:

Free tier: 100 requests per hour
Pro tier: 1,000 requests per hour
Enterprise: Custom limits

Rate limit headers are included in all responses:

Rate Limit Headers:

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

Endpoints

Agents

List Agents

GET /agents:

GET /agents
Authorization: Bearer YOUR_API_KEY

http

Response:

{
  "data": [
    {
      "id": "agent_123",
      "name": "my-first-agent",
      "status": "active",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}

json

Get Agent

GET /agents/{id}:

GET /agents/agent_123
Authorization: Bearer YOUR_API_KEY

http

Create Agent

POST /agents:

POST /agents
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "name": "my-new-agent",
  "description": "A new AI agent",
  "handler": "// Your agent code here"
}

http

Update Agent

PUT /agents/{id}:

PUT /agents/agent_123
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "name": "updated-agent-name",
  "description": "Updated description"
}

http

Delete Agent

DELETE /agents/{id}:

DELETE /agents/agent_123
Authorization: Bearer YOUR_API_KEY

http

Executions

Execute Agent

POST /agents/{id}/execute:

POST /agents/agent_123/execute
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "input": "Hello, world!",
  "context": {
    "user_id": "user_123",
    "session_id": "session_456"
  }
}

http

Response:

{
  "data": {
    "execution_id": "exec_789",
    "response": "Hello! You said: \"Hello, world!\"",
    "metadata": {
      "timestamp": "2024-01-01T00:00:00Z",
      "agent": "my-first-agent"
    },
    "execution_time": 0.123,
    "status": "completed"
  }
}

json

Get Execution

GET /executions/{id}:

GET /executions/exec_789
Authorization: Bearer YOUR_API_KEY

http

Teams

List Teams

GET /teams:

GET /teams
Authorization: Bearer YOUR_API_KEY

http

Create Team

POST /teams:

POST /teams
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "name": "My Team",
  "description": "A team for collaboration"
}

http

Error Handling

The API uses standard HTTP status codes and returns error details in the response body:

Error Response:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is invalid",
    "details": {
      "field": "name",
      "reason": "required"
    }
  }
}

json

Common Error Codes

400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
429 - Too Many Requests
500 - Internal Server Error

SDKs

We provide official SDKs for popular languages:

JavaScript/TypeScript: npm install @reminix/sdk
Python: pip install reminix-sdk
Go: go get github.com/reminix-ai/sdk-go

JavaScript Example

Using the JavaScript SDK:

import { ReminixClient } from '@reminix/sdk'

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

// Execute an agent
const result = await client.agents.execute('agent_123', {
  input: 'Hello, world!',
  context: { user_id: 'user_123' }
})

console.log(result.response)

javascript

Python Example

Using the Python SDK:

from reminix import ReminixClient

client = ReminixClient(api_key='YOUR_API_KEY')

# Execute an agent
result = client.agents.execute('agent_123', {
    'input': 'Hello, world!',
    'context': {'user_id': 'user_123'}
})

print(result.response)

python