🚀 VBOT is an Agent of AgentDAO.com
Buy ESHBuy ADAO

VBOT API Documentation

Complete API reference with sample code and examples

Back to VBOT

Categories

Getting Started

The VBOT API allows you to manage content generation, agent orchestration, and workflow automation. All API endpoints are RESTful and return JSON responses.

Base URL

https://vbot.vercel.app

Authentication

VBOT supports multiple authentication methods:

  • Session-based: For web applications (uses cookies)
  • VNOC API Key: For programmatic access
  • Admin API Key: For administrative operations
POST/api/register
None

Register a new user account

Parameters

NameTypeRequiredDescription
namestringYesUser full name
emailstringYesUser email address
passwordstringYesUser password

Request Example

{
  "name": "John Doe",
  "email": "john@example.com",
  "password": "securepassword123"
}

Response Example

{
  "message": "User registered successfully"
}

cURL Example

curl -X POST https://vbot.vercel.app/api/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "password": "securepassword123"
  }'
GET/api/user
Session Required

Get current user information

Response Example

{
  "id": "user_123",
  "name": "John Doe",
  "email": "john@example.com",
  "provider": "credentials",
  "isAdmin": false,
  "createdAt": "2024-01-15T10:30:00Z"
}

cURL Example

curl -X GET https://vbot.vercel.app/api/user \
  -H "Cookie: next-auth.session-token=your_session_token"
POST/api/assets/new
Session Required

Create a new asset

Parameters

NameTypeRequiredDescription
namestringYesAsset name
urlstringYesAsset URL
descriptionstringYesAsset description

Request Example

{
  "name": "My Website",
  "url": "https://example.com",
  "description": "A sample website for content generation"
}

Response Example

{
  "id": "asset_123",
  "name": "My Website",
  "url": "https://example.com",
  "description": "A sample website for content generation",
  "userId": "user_123",
  "createdAt": "2024-01-15T10:30:00Z"
}

cURL Example

curl -X POST https://vbot.vercel.app/api/assets/new \
  -H "Content-Type: application/json" \
  -H "Cookie: next-auth.session-token=your_session_token" \
  -d '{
    "name": "My Website",
    "url": "https://example.com",
    "description": "A sample website for content generation"
  }'
GET/api/assets/existing
Session Required

Get all assets for current user

Response Example

[
  {
    "id": "asset_123",
    "name": "My Website",
    "url": "https://example.com",
    "description": "A sample website for content generation",
    "createdAt": "2024-01-15T10:30:00Z"
  }
]

cURL Example

curl -X GET https://vbot.vercel.app/api/assets/existing \
  -H "Cookie: next-auth.session-token=your_session_token"
POST/api/jobs/single-blog
Session Required

Create a single blog post job

Parameters

NameTypeRequiredDescription
assetIdstringYesAsset ID
themestringYesBlog theme

Request Example

{
  "assetId": "asset_123",
  "theme": "The Future of AI in Business"
}

Response Example

{
  "success": true,
  "jobId": "job_123",
  "message": "Blog job created successfully"
}

cURL Example

curl -X POST https://vbot.vercel.app/api/jobs/single-blog \
  -H "Content-Type: application/json" \
  -H "Cookie: next-auth.session-token=your_session_token" \
  -d '{
    "assetId": "asset_123",
    "theme": "The Future of AI in Business"
  }'
POST/api/jobs/single-tweet
Session Required

Create a single tweet job

Parameters

NameTypeRequiredDescription
assetIdstringYesAsset ID
themestringYesTweet theme

Request Example

{
  "assetId": "asset_123",
  "theme": "AI Innovation"
}

Response Example

{
  "success": true,
  "jobId": "job_456",
  "message": "Tweet job created successfully"
}

cURL Example

curl -X POST https://vbot.vercel.app/api/jobs/single-tweet \
  -H "Content-Type: application/json" \
  -H "Cookie: next-auth.session-token=your_session_token" \
  -d '{
    "assetId": "asset_123",
    "theme": "AI Innovation"
  }'
POST/api/vnoc/v1/account/register
VNOC API Key

Register user via VNOC API

Parameters

NameTypeRequiredDescription
vnocAPIKeystringYesVNOC API Key
namestringYesUser name
emailstringYesUser email
passwordstringYesUser password

Request Example

{
  "vnocAPIKey": "your_vnoc_api_key",
  "name": "John Doe",
  "email": "john@example.com",
  "password": "securepassword123"
}

Response Example

{
  "message": "User registered successfully. Please remember to save the user credentials."
}

cURL Example

curl -X POST https://vbot.vercel.app/api/vnoc/v1/account/register \
  -H "Content-Type: application/json" \
  -d '{
    "vnocAPIKey": "your_vnoc_api_key",
    "name": "John Doe",
    "email": "john@example.com",
    "password": "securepassword123"
  }'
POST/api/vnoc/v1/account/view
VNOC API Key + User Credentials

Get user account information via VNOC API

Parameters

NameTypeRequiredDescription
vnocAPIKeystringYesVNOC API Key
userEmailstringYesUser email
userPasswordstringYesUser password

Request Example

{
  "vnocAPIKey": "your_vnoc_api_key",
  "userEmail": "john@example.com",
  "userPassword": "securepassword123"
}

Response Example

{
  "success": true,
  "user": {
    "id": "user_123",
    "name": "John Doe",
    "email": "john@example.com",
    "isAdmin": false,
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

cURL Example

curl -X POST https://vbot.vercel.app/api/vnoc/v1/account/view \
  -H "Content-Type: application/json" \
  -d '{
    "vnocAPIKey": "your_vnoc_api_key",
    "userEmail": "john@example.com",
    "userPassword": "securepassword123"
  }'
GET/api/vnoc/v1/agents/list
VNOC API Key

List all available agents

Parameters

NameTypeRequiredDescription
vnocAPIKeystringYesVNOC API Key
categorystringNoFilter by category
searchstringNoSearch agents

Response Example

{
  "success": true,
  "agents": [
    {
      "id": "agent_123",
      "name": "ContentAgent",
      "version": "1.0.0",
      "description": "AI-powered content creation and optimization",
      "category": "Content",
      "capabilities": [
        "blog-writing",
        "content-optimization"
      ],
      "pricing": {
        "free": true
      },
      "isActive": true
    }
  ]
}

cURL Example

curl -X GET "https://vbot.vercel.app/api/vnoc/v1/agents/list?vnocAPIKey=your_vnoc_api_key&category=Content"
POST/api/vnoc/v1/agents/register
Admin API Key

Register a new agent

Parameters

NameTypeRequiredDescription
adminAPIKeystringYesAdmin API Key
namestringYesAgent name
versionstringYesAgent version
descriptionstringYesAgent description
categorystringYesAgent category
capabilitiesarrayYesAgent capabilities
apiEndpointstringYesAgent API endpoint
authTypestringYesAuthentication type

Request Example

{
  "adminAPIKey": "your_admin_api_key",
  "name": "MyCustomAgent",
  "version": "1.0.0",
  "description": "A custom AI agent",
  "category": "Content",
  "capabilities": [
    "text-generation",
    "summarization"
  ],
  "apiEndpoint": "https://my-agent.com/api",
  "authType": "apiKey",
  "pricing": {
    "free": true
  }
}

Response Example

{
  "success": true,
  "message": "Agent registered successfully",
  "agent": {
    "id": "agent_456",
    "name": "MyCustomAgent",
    "version": "1.0.0",
    "isActive": true
  }
}

cURL Example

curl -X POST https://vbot.vercel.app/api/vnoc/v1/agents/register \
  -H "Content-Type: application/json" \
  -d '{
    "adminAPIKey": "your_admin_api_key",
    "name": "MyCustomAgent",
    "version": "1.0.0",
    "description": "A custom AI agent",
    "category": "Content",
    "capabilities": ["text-generation", "summarization"],
    "apiEndpoint": "https://my-agent.com/api",
    "authType": "apiKey",
    "pricing": {"free": true}
  }'
POST/api/packages/create-package
Session or VNOC API Key

Create a new content package

Parameters

NameTypeRequiredDescription
playbookstringYesPackage type (social-package-intro, blog-package)
assetIdstringYesAsset ID
vnocAPIKeystringNoVNOC API Key (optional)

Request Example

{
  "playbook": "blog-package",
  "assetId": "asset_123",
  "vnocAPIKey": "your_vnoc_api_key"
}

Response Example

{
  "success": true,
  "packageId": "package_123",
  "message": "Package created successfully"
}

cURL Example

curl -X POST https://vbot.vercel.app/api/packages/create-package \
  -H "Content-Type: application/json" \
  -H "Cookie: next-auth.session-token=your_session_token" \
  -d '{
    "playbook": "blog-package",
    "assetId": "asset_123"
  }'
POST/api/vnoc/v1/integrations/linkedin/post
VNOC API Key + User Credentials

Post content to LinkedIn

Parameters

NameTypeRequiredDescription
vnocAPIKeystringYesVNOC API Key
userEmailstringYesUser email
userPasswordstringYesUser password
assetIdstringYesAsset ID
contentobjectYesLinkedIn post content

Request Example

{
  "vnocAPIKey": "your_vnoc_api_key",
  "userEmail": "john@example.com",
  "userPassword": "securepassword123",
  "assetId": "asset_123",
  "content": {
    "text": "Check out this amazing AI innovation! #AI #Innovation",
    "visibility": "PUBLIC"
  }
}

Response Example

{
  "success": true,
  "message": "Successfully posted to LinkedIn",
  "postId": "linkedin_post_123",
  "jobId": "job_789"
}

cURL Example

curl -X POST https://vbot.vercel.app/api/vnoc/v1/integrations/linkedin/post \
  -H "Content-Type: application/json" \
  -d '{
    "vnocAPIKey": "your_vnoc_api_key",
    "userEmail": "john@example.com",
    "userPassword": "securepassword123",
    "assetId": "asset_123",
    "content": {
      "text": "Check out this amazing AI innovation! #AI #Innovation",
      "visibility": "PUBLIC"
    }
  }'

Rate Limits

API requests are rate limited to ensure fair usage and system stability.

  • Free Tier: 100 requests per hour
  • Pro Tier: 1,000 requests per hour
  • Enterprise: 10,000 requests per hour

Error Codes

CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing authentication
403Forbidden - Insufficient permissions
404Not Found - Resource not found
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Server error