API ReferenceAgents
BimpeAI — configure integration
Connect bumpa, paystack, or stripe directly (returns channel_id on success). For google_calendar and google_sheets returns onboarding_url to complete OAuth in the dashboard.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Team API key (prefix sk_). You may also send the key via X-Api-Key header.
In: header
Path Parameters
agentId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/console/agents/string/integrations/bimpeai/configure" \ -H "Content-Type: application/json" \ -d '{ "type": "paystack" }'{ "message": "Success", "data": { "onboarding_url": "https://agent.bimpe.ai/agents/agt_123/integrations?connect=google_calendar" }}{ "message": "Success", "data": { "success": true, "channel_id": "string" }}{ "message": "Invalid Paystack API keys", "error": "Bad Request", "code": "integration_connection_failed", "statusCode": 400, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Invalid API key.", "error": "Unauthorized", "code": "api_key_invalid", "statusCode": 401, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "This API key is missing the required scope: conversations:read.", "error": "Forbidden", "code": "insufficient_scope", "statusCode": 403, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Agent not found", "error": "Not Found", "code": "not_found", "statusCode": 404, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Integration limit reached for your plan. Please upgrade to add more integrations.", "error": "Conflict", "code": "integration_limit_reached", "statusCode": 409, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}