help
3Min API service guide. Returns detailed reference by topic.
When to use:
- Before using any tool for the first time
- When encountering errors (topic: "troubleshooting")
- To understand field rules, error codes, or business constraints
Topics: overview, pricing, endpoints, collaborators, webhooks, api, troubleshooting, logs, subscription, stats, archives, mcp
endpoints
Manage API endpoints: list, view, create, update, and deploy to production. Use help(topic: "endpoints") for field rules and error codes.
Webhook vs Notification (different purposes):
- Webhook: forwards full API call data to your server URL on every API call. For data processing.
- Notification: sends short alerts to Discord/Slack/Telegram for system events only (webhook failure, usage warning, etc.). NOT triggered on API calls.
Workflow:
1. create — new endpoint
2. api_call — test in sandbox
3. logs — verify results
4. collaborators — create keys and invite partners
5. deploy — push sandbox config to production (when all testing is done)
Only do what the user asks. After completing a step, briefly list what else is available and let the user choose.
Supported: list, get, create, update, deploy, webhook/notification config.
Not supported (web only): delete endpoint, toggle active/inactive.
api_call
Call your API endpoint via the Gateway using the default collaboration key. Use help(topic: "api") for error codes.
Workflow:
1. endpoints(action: "get") — check field definitions and API key
2. api_call(environment: "sandbox") — test with sandbox
3. logs — verify the result
4. collaborators — create keys and invite partners
5. endpoints(action: "deploy") — deploy to production (when all testing is done)
Only do what the user asks. After completing a step, briefly list what else is available and let the user choose.
- POST: Create record (async, 202). Requires body.
- GET: Read record (sync, 200). Requires record_id.
- PUT: Replace record (async, 202). Requires record_id + body.
- DELETE: Delete record (async, 202). Requires record_id.
Note: To search records by keyword, use the logs tool (search_text), not api_call GET. GET only retrieves a single record by record_id.
Supported: POST, GET, PUT, DELETE via default collaboration key.
Not supported (web only): call with non-default collaboration key.
logs
Search and retrieve API call logs. This is the tool for finding records by keyword or verifying API call results. Two modes: record lookup (by record_id) or text search (by search_text with date range). Use help(topic: "logs") for error codes and search constraints.
When to use this tool:
- "Show me orders containing John" → text search (search_text: "John", start_date, end_date)
- "Check if my test call went through" → record lookup (record_id from api_call response)
Workflow:
1. Record lookup — exact record_id, returns full payload. If payload is null, it has been archived — retry with fetch_archived=true to retrieve it.
2. Text search — partial match (ILIKE) on searchable fields. Min 3 chars, max 31-day range, paginated (10 per page).
Note: For bulk export of archived data, use the archives tool instead.
Supported: single record lookup, text search with date range, archived payload retrieval.
Not supported (web only): visual log browser, CSV export, client filter.
stats
Get API usage statistics: monthly summary and daily CRUD breakdown with success/failure counts and average response time. Use help(topic: "stats") for field details.
Workflow:
1. stats — check current month usage
2. subscription — compare usage against plan limit, consider upgrade if needed
Note: Statistics may have slight delays. Response time excludes Read operations.
Supported: monthly summary, daily breakdown, historical months.
Not supported (web only): visual charts, date range comparison.
collaborators
Manage collaboration keys and invitations for your endpoints. Use help(topic: "collaborators") for permission rules and error codes.
Workflow:
1. list_keys — view existing collaboration keys
2. create_key — create a key for a new partner
3. update_permissions — set CRUD permissions per environment
4. invite — send email invitation to a collaborator
5. list_invitations — check invitation status
Only do what the user asks. After completing a step, briefly list what else is available and let the user choose.
Supported: list keys, create key, update permissions, list invitations, invite by email.
Not supported (web only): delete/deactivate key, regenerate API key, revoke invitation, edit key name/description.
subscription
Get current subscription plan, usage, and billing info. No parameters needed. Use help(topic: "subscription") for field details.
Workflow:
1. subscription — check usage percentage and plan limits
2. If usage is high, review available_plans for upgrade options
3. Plan changes are made on the web dashboard (manage_url in response)
Supported: view current plan, usage, billing period, available plans.
Not supported (web only): change plan, cancel, reactivate, payment management.
archives
Bulk download of archived API payloads. Only needed for bulk export — for individual records, use logs with fetch_archived=true instead. Production records older than the retention period have payloads archived as gzip-compressed JSONL files. Sandbox records are not archived. Use help(topic: "archives") for file format and error codes.
Workflow:
1. list — browse archived files by date range (max 3 months, paginated)
2. download — get a temporary download URL (expires in 5 minutes)
3. Download the file, decompress (gzip), and parse line-by-line as JSON
4. If download fails in your environment, provide the URL to the user for manual download
Supported: list archive files, get download URL.
Not supported (web only): visual archive browser.