Client access only. The Gwiksoft API is provided to clients as part of a signed service engagement. It is not a public or self-serve product; access, credentials, and usage terms are set out in your agreement. Talk to us
API Reference
Reference for the Gwiksoft API, provided to clients as part of a signed service engagement.
https://api.gwiksoft.com/v1v1.0Authentication
API key-based authentication with OAuth 2.0 support
Rate Limits
1,000 requests/hour for standard, unlimited for enterprise
REST Architecture
Clean, predictable REST API with JSON responses
Secure by Default
HTTPS-only with encryption at rest and in transit
Authentication
Authenticate your API requests using your API key in the Authorization header:
Keep your API keys secure. Never expose them in client-side code or public repositories.
Core Endpoints
/api/v1/agentsCreate a new AI agent
/api/v1/agents/{id}Retrieve agent details
/api/v1/agents/{id}Update agent configuration
/api/v1/agents/{id}Delete an agent
/api/v1/conversationsStart a new conversation
/api/v1/conversations/{id}Get conversation history
/api/v1/orders/syncSync order data
/api/v1/analyticsRetrieve performance analytics
Response Format
All API responses follow a consistent JSON structure:
Error Codes
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Resource created |
| 400 | Bad request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not found |
| 429 | Rate limit exceeded |
| 500 | Internal server error |
SDKs & Libraries
Node.js
Python
PHP
Ruby
Java
Go
Need API Support?
Our developer support team can help with integration questions, debugging, and best practices.