Developer API Reference
v1
Example API documentation for the Arkintel platform to demonstrate how developers can interact with out services. Build AI-powered applications with our comprehensive set of RESTful APIs. Not official documentation.
RESTful JSON APIs
OAuth 2.1 Authentication
Detailed Documentation
Authentication
All API requests must include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYTo obtain an API key, book a demo with our team. After the demo, we'll provide you with API keys for development and production environments.
Base URL
All API endpoints are relative to the following base URL:
https://api.arkintel.comFor development and testing, you can use our sandbox environment:
https://sandbox.api.arkintel.comRequest/Response Format
Headers
| Header | Description |
|---|---|
| Content-Type | application/json for request and response bodies |
| Authorization | Bearer token for authentication |
| X-Request-ID | Optional request identifier for tracking |
Error Responses
| Status | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Insufficient permissions |
| 429 | Too Many Requests - Rate limit exceeded |
| 5xx | Server Error - Please contact support |
API Endpoints
User Permissions
Complete authentication and role-based permission management for your applications.
Authentication
POST
Agent Analytics
Comprehensive analytics for tracking and analyzing agent performance and usage.
Analytics
GET
Agent File Management
APIs for managing files associated with your AI agents.
Content
POST
Agent Setup
Configure and customize your AI agents with specific instructions and parameters.
Configuration
PUT
Websocket Chat
Real-time chat connections to your AI agents via websockets.
Communication
WS
Super Analytics
Advanced analytics aggregating data across all your AI agents.
Analytics
GET
User State
Manage and persist user state information across sessions.
State Management
POST
Model Picker
Automatically select the optimal AI model for each task based on requirements.
Models
POST
Integrations
Connect with external services and data sources.
Integration
POST