Getting Started
Welcome to the SpiderNine API! Our RESTful API allows you to create, manage, and deploy agentic AI solutions programmatically.
Base URL
https://api.spidernine.com/v1
Quick Start
Get up and running in minutes with our API:
- Sign up for a SpiderNine account
- Generate an API key from your dashboard
- Make your first API call
- Deploy your first agent
Authentication
SpiderNine uses API keys for authentication. Include your API key in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api.spidernine.com/v1/agents
API Key Management
- Generate: Create new API keys in your dashboard
- Rotate: Regularly rotate keys for security
- Scope: Limit key permissions by resource type
- Monitor: Track API key usage and rate limits
Agents API
Create and manage AI agents that can autonomously execute tasks.
Create an Agent
POST /v1/agents
{
"name": "Research Assistant",
"description": "AI agent for market research tasks",
"suite": "research_strategy",
"capabilities": [
"web_search",
"data_analysis",
"report_generation"
],
"config": {
"max_tasks_per_day": 100,
"timeout_minutes": 30
}
}
List Agents
GET /v1/agents
Response:
{
"agents": [
{
"id": "agent_123",
"name": "Research Assistant",
"status": "active",
"created_at": "2025-01-10T10:00:00Z"
}
]
}
Agent Configuration
- Capabilities: Define what your agent can do
- Constraints: Set limits and safety boundaries
- Integrations: Connect to external APIs and services
- Monitoring: Track performance and usage metrics
Tasks API
Submit tasks to your agents and monitor their execution.
Create a Task
POST /v1/tasks
{
"agent_id": "agent_123",
"instruction": "Research the latest trends in AI automation",
"context": {
"industry": "technology",
"timeframe": "last_6_months"
},
"priority": "high",
"callback_url": "https://your-app.com/webhooks/task-complete"
}
Task Status
GET /v1/tasks/task_456
Response:
{
"id": "task_456",
"status": "completed",
"progress": 100,
"result": {
"summary": "AI automation trends analysis",
"data": {...},
"recommendations": [...]
},
"execution_time": 1847,
"created_at": "2025-01-10T10:00:00Z",
"completed_at": "2025-01-10T10:30:47Z"
}
Task Management
- Queue: Tasks are processed in priority order
- Status: pending, running, completed, failed
- Results: Structured output with metadata
- Retry: Automatic retry for failed tasks
Webhooks
Receive real-time notifications about task completion and agent status changes.
Webhook Events
- task.completed: Task finished successfully
- task.failed: Task encountered an error
- agent.status_changed: Agent status updated
- usage.limit_reached: Rate limit or quota reached
Webhook Payload
{
"event": "task.completed",
"timestamp": "2025-01-10T10:30:47Z",
"data": {
"task_id": "task_456",
"agent_id": "agent_123",
"status": "completed",
"result": {...}
}
}
SDKs and Libraries
Use our official SDKs to integrate SpiderNine into your applications.
Python SDK
pip install spidernine
from spidernine import SpiderNine
client = SpiderNine(api_key="your_key")
agent = client.agents.create(
name="My Agent",
suite="sales_cx"
)
Node.js SDK
npm install @spidernine/sdk
const SpiderNine = require('@spidernine/sdk');
const client = new SpiderNine({
apiKey: 'your_key'
});
const agent = await client.agents.create({
name: 'My Agent',
suite: 'finance'
});
Available SDKs
- Python: Full-featured SDK with async support
- Node.js: TypeScript definitions included
- Go: High-performance SDK for backend services
- Java: Enterprise-ready with Spring Boot integration
- REST API: Direct HTTP calls for any language
Rate Limits
API rate limits by plan:
- Starter: 1,000 requests/hour
- Growth: 10,000 requests/hour
- Enterprise: Custom limits available
Error Handling
The API uses conventional HTTP response codes:
- 200: Success
- 400: Bad Request - Invalid parameters
- 401: Unauthorized - Invalid API key
- 429: Too Many Requests - Rate limit exceeded
- 500: Internal Server Error
Need Help?
Join our developer community or contact our technical support team.