Remote API - Complete Endpoint Reference

Complete reference for all endpoints in the AGNT Remote API (https://api.agnt.gg).

Table of Contents

Marketplace

Browse, publish, and install marketplace items.

Base: /marketplace

Browse Items

GET /marketplace/items

Auth: Optional

Query Params:

  • category - Filter by category
  • search - Search query
  • sort - Sort field (popularity, rating, recent)
  • page - Page number
  • limit - Items per page

Response:

{
  "success": true,
  "items": [
    {
      "id": "item-123",
      "name": "SEO Optimizer",
      "description": "Automated SEO optimization workflow",
      "type": "workflow",
      "category": "marketing",
      "price": 0,
      "rating": 4.8,
      "downloads": 1250,
      "author": {
        "id": "user-456",
        "name": "John Doe"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "total": 100
  }
}

Get Item Details

GET /marketplace/items/:id

Auth: Optional

GET /marketplace/items/featured

Auth: Optional

Install Item

POST /marketplace/items/:id/install

Auth: Required

Response:

{
  "success": true,
  "message": "Item installed successfully",
  "installedId": "local-workflow-789"
}

Purchase Item

POST /marketplace/items/:id/purchase

Auth: Required

Body: { "paymentMethodId": "pm_123" }

Publish Item

POST /marketplace/publish

Auth: Required

Body:

{
  "type": "workflow",
  "itemId": "workflow-123",
  "name": "My Workflow",
  "description": "Description",
  "category": "automation",
  "price": 0,
  "tags": ["automation", "productivity"]
}

Update Listing

PUT /marketplace/items/:id

Auth: Required (must be owner)

Remove Listing

DELETE /marketplace/items/:id

Auth: Required (must be owner)

Get My Published Items

GET /marketplace/my-workflows

Auth: Required

Get My Purchases

GET /marketplace/my-purchases

Auth: Required

Get My Installs

GET /marketplace/my-installs

Auth: Required

Check for Updates

GET /marketplace/updates

Auth: Required

Reviews

Submit Review

POST /marketplace/reviews

Auth: Required

Body:

{
  "itemId": "item-123",
  "rating": 5,
  "comment": "Excellent workflow!",
  "title": "Great tool"
}

Get Item Reviews

GET /marketplace/items/:id/reviews

Auth: Optional

Update Review

PUT /marketplace/reviews/:id

Auth: Required (must be author)

Delete Review

DELETE /marketplace/reviews/:id

Auth: Required (must be author)

Vote on Review

POST /marketplace/reviews/:id/vote

Auth: Required | Body: { "vote": "up" | "down" }

Analytics (Publishers)

Get Item Analytics

GET /marketplace/workflows/:id/analytics

Auth: Required (must be owner)

Response:

{
  "views": 1500,
  "installs": 250,
  "revenue": 1250.0,
  "rating": 4.8,
  "reviews": 45,
  "trend": "up"
}

Get Earnings

GET /marketplace/my-earnings

Auth: Required

Users & Subscriptions

User management and billing.

Base: /users

Register

POST /users/register

Auth: Not required

Body:

{
  "email": "user@example.com",
  "password": "secure-password",
  "name": "John Doe"
}

Login

POST /users/login

Auth: Not required

Body: { "email": "...", "password": "..." }

Response:

{
  "success": true,
  "token": "jwt-token",
  "user": {
    "id": "user-123",
    "email": "user@example.com",
    "name": "John Doe"
  }
}

Get Profile

GET /users/profile

Auth: Required

Update Profile

PUT /users/profile

Auth: Required

Body:

{
  "name": "New Name",
  "bio": "User bio",
  "avatar": "https://..."
}

Generate API Key

POST /users/generate-api-key

Auth: Required

Get User Stats

GET /users/user-stats

Auth: Required

Response:

{
  "totalAgents": 15,
  "totalWorkflows": 8,
  "totalExecutions": 1250,
  "creditsUsed": 5000,
  "creditsRemaining": 5000
}

Get Credits

GET /users/credits

Auth: Required

Subscriptions

Create Subscription

POST /users/subscription/create

Auth: Required

Body:

{
  "planId": "personal_monthly",
  "paymentMethodId": "pm_123"
}

Get Subscription Status

GET /users/subscription/status

Auth: Required

Cancel Subscription

POST /users/subscription/cancel

Auth: Required

Reactivate Subscription

POST /users/subscription/reactivate

Auth: Required

Update Subscription

POST /users/subscription/update

Auth: Required

Body: { "planId": "business_monthly" }

Executions

View execution history and analytics.

Base: /executions

List Executions

GET /executions

Auth: Required

Query Params:

  • page - Page number
  • limit - Items per page
  • status - Filter by status (success, failed, running)
  • agentId - Filter by agent
  • workflowId - Filter by workflow

Get Execution Details

GET /executions/:id

Auth: Required

Response:

{
  "id": "exec-123",
  "agentId": "agent-456",
  "workflowId": "workflow-789",
  "status": "success",
  "startedAt": "2025-11-25T10:00:00Z",
  "completedAt": "2025-11-25T10:05:00Z",
  "duration": 300000,
  "tokensUsed": 1500,
  "cost": 0.03,
  "steps": [
    {
      "name": "Research",
      "status": "success",
      "output": "..."
    }
  ]
}

Get Agent Activity

POST /executions/activity

Auth: Required

Body:

{
  "agentId": "agent-123",
  "startDate": "2025-11-01",
  "endDate": "2025-11-30"
}

Custom Tools

Manage custom tool definitions.

Base: /custom-tools

List Custom Tools

GET /custom-tools

Auth: Required

Get Custom Tool

GET /custom-tools/:id

Auth: Required

Save Custom Tool

POST /custom-tools/save
PUT /custom-tools/:id

Auth: Required

Body:

{
  "name": "Custom API Tool",
  "description": "Calls external API",
  "type": "api",
  "config": {
    "url": "https://api.example.com",
    "method": "POST",
    "headers": {},
    "body": {}
  },
  "inputSchema": {},
  "outputSchema": {}
}

Delete Custom Tool

DELETE /custom-tools/:id

Auth: Required

Content Outputs

Manage generated content.

Base: /content-outputs

List Content Outputs

GET /content-outputs

Auth: Required

Get Content Output

GET /content-outputs/:id

Auth: Required

Save Content Output

POST /content-outputs/save

Auth: Required

Get by Workflow

GET /content-outputs/workflow/:workflowId

Auth: Required

Get by Tool

GET /content-outputs/tool/:toolId

Auth: Required

Streaming

Real-time AI streaming endpoints.

Base: /stream

Start Tool Forge Stream

POST /stream/start-tool-forge-stream

Auth: Required

Content-Type: multipart/form-data

Body:

  • message - User message
  • files - Optional file uploads
  • config - Stream configuration

Response: Server-Sent Events (SSE) stream

Cancel Tool Forge Stream

POST /stream/cancel-tool-forge-stream

Auth: Required

Start Chat Stream

POST /stream/start-chat-stream

Auth: Required | Content-Type: multipart/form-data

Cancel Chat Stream

POST /stream/cancel-chat-stream

Auth: Required

Generate Tool

POST /stream/generate-tool

Auth: Required

Body:

{
  "description": "A tool that fetches weather data",
  "requirements": ["API integration", "Error handling"]
}

Generate Workflow

POST /stream/generate-workflow

Auth: Required

Body:

{
  "description": "Automated content creation workflow",
  "steps": ["Research", "Write", "Publish"]
}

Email Services

Email integration and notifications.

Base: /email

Initialize Email

POST /email/initialize

Auth: Required

Poll Emails

GET /email/poll

Auth: Required

Send Email

POST /email/send

Auth: Required

Body:

{
  "to": "recipient@example.com",
  "subject": "Subject",
  "body": "Email body",
  "html": "<p>HTML body</p>"
}

Send Feedback

POST /email/send-feedback

Auth: Required

Body:

{
  "type": "bug" | "feature" | "general",
  "message": "Feedback message",
  "email": "user@example.com"
}

Send Enterprise Inquiry

POST /email/send-enterprise-inquiry

Auth: Required

Webhooks

Webhook management for event notifications.

Base: /webhooks

Poll Webhooks

GET /webhooks/poll

Auth: Required

Confirm Processed Triggers

POST /webhooks/confirm-processed

Auth: Required

Body: { "triggerIds": ["trigger-1", "trigger-2"] }

Webhook Receiver

ALL /webhooks/:workflowId

Auth: Not required (uses webhook secret)

Receives webhook payloads and triggers workflows.

Referrals

Referral program management.

Base: /referrals

Get Referral Count

GET /referrals/count

Auth: Not required

Create Referral

POST /referrals/create

Auth: Required

Body:

{
  "userId": "user-123",
  "referralCode": "ABC123"
}

Get Network Score

GET /referrals/network-score/:email

Auth: Not required

Response:

{
  "personalBalance": 500,
  "networkScore": 1250,
  "totalScore": 1750,
  "breakdown": {
    "personal": 500,
    "network": 1250,
    "total": 1750
  }
}

Verify Referral Code

GET /referrals/verify/:code

Auth: Not required

Get Leaderboard

GET /referrals/leaderboard?limit=10

Auth: Optional

Process Referral

POST /referrals/referral

Auth: Not required

Body:

{
  "referralCode": "ABC123",
  "newUserEmail": "newuser@example.com"
}

Get User Referral Info

GET /referrals/user/:email

Auth: Not required

Get Referral Tree

GET /referrals/tree/:userEmail

Auth: Not required

Returns 3-level deep referral tree with activity data.

Update Pseudonym

POST /referrals/update-pseudonym

Auth: Required

Body: { "newPseudonym": "CoolUser123" }

Check Pseudonym Availability

POST /referrals/check-availability

Auth: Not required

Body: { "pseudonym": "CoolUser123" }

Commission Endpoints

Get Commission Summary

GET /referrals/commissions/summary

Auth: Required

Get Commission History

GET /referrals/commissions/history

Auth: Required

Waitlist & Onboarding

Waitlist and user onboarding management.

Waitlist

Base: /waitlist

Get Waitlist Count

GET /waitlist/count

Auth: Not required

Join Waitlist

POST /waitlist/join

Auth: Not required

Body:

{
  "email": "user@example.com",
  "interest": "AI automation"
}

Onboarding

Base: /onboarding

Get Progress

GET /onboarding/progress

Auth: Required

Complete Onboarding

POST /onboarding/complete

Auth: Required

Get Analytics

GET /onboarding/analytics

Auth: Required

Unsubscribe

GET /onboarding/unsubscribe?email=user@example.com
POST /onboarding/unsubscribe

Auth: Not required

Track Event

GET /onboarding/track/:sequenceId/:eventType

Auth: Not required

Auth Providers

OAuth provider and API key management.

Base: /auth

List Providers

GET /auth/providers

Auth: Required

Create Provider

POST /auth/providers

Auth: Required

Body:

{
  "name": "custom-api",
  "type": "api_key",
  "config": {}
}

Update Provider

PUT /auth/providers/:id

Auth: Required

Delete Provider

DELETE /auth/providers/:id

Auth: Required

Get Provider

GET /auth/providers/:id

Auth: Required

Store API Key

POST /auth/apikeys/:providerId

Auth: Required

Body: { "apiKey": "sk-..." }

Retrieve API Key

GET /auth/apikeys/:providerId

Auth: Required

Connect OAuth Provider

GET /auth/connect/:provider

Auth: Required

Initiates OAuth flow for provider (google, zapier, etc.)

Disconnect Provider

POST /auth/disconnect/:provider

Auth: Required

Get Connected Apps

GET /auth/connected

Auth: Required

Get Valid Token

GET /auth/valid-token?provider=google

Auth: Required

Returns a valid access token for the provider.

Common Patterns

Pagination

Most list endpoints support pagination:

GET /endpoint?page=1&limit=20

Filtering

GET /endpoint?status=active&category=automation

Sorting

GET /endpoint?sort=createdAt&order=desc
GET /endpoint?search=keyword

Error Handling

All endpoints return consistent error responses:

{
  "success": false,
  "error": "Error message",
  "statusCode": 400,
  "details": "Additional error details"
}

Next Steps