API
Zynapse API Documentation
This documentation provides details on the Zynapse API, designed to interface with a variety of services, including a transformer model for automation tasks, developer support for Leo code, and system administration tasks for nodes using zero-knowledge proof infrastructure.
Overview
The Zynapse API offers a collection of RESTful endpoints for developers working with Aleo development, node administration, and automated messaging across multiple platforms. It's divided into three key areas:
Automation and Chat Interface
Developer Tools for Leo Code
Zero-Knowledge Proof Infrastructure Management
Automation and Chat Interface
POST /chat/completions
/chat/completionsChat Completions
This is the primary endpoint used to interact with the Zynapse API's transformer model. It processes commands or natural language input to automate tasks or retrieve information.
Usage: Send JSON data with the command or query in the request body. The transformer model processes the input and returns a response facilitating the completion of various automated tasks.
Developer Tools for Leo Code
GET /query/
/query/Query Leo Code Generation
This endpoint is specifically designed for developers working with Leo code in Aleo projects. It leverages privacy-preserving infrastructure to generate questions or provide assistance related to Leo code.
Usage: A GET request to this endpoint will prompt the system to return information or generate queries regarding Leo code. The exact parameters and expected response format should be documented, ensuring developers understand how to structure their requests.
Zero-Knowledge Proof Infrastructure Management
POST /send_mail
/send_mailSend Email
Integrates with email systems to send out communications.
POST /send_twitter_dm
/send_twitter_dmSend Twitter Direct Messages
Enables the automated sending of direct messages on Twitter.
POST /send_telegram_dm
/send_telegram_dmSend Telegram Direct Messages
Automates the sending of messages to Telegram users.
POST /request_otp
/request_otpRequest OTP
Generates a one-time password for secure authentication.
POST /authenticate_with_otp
/authenticate_with_otpAuthenticate With OTP
Provides authentication for users or sessions based on an OTP.
POST /scrape_telegram_member
/scrape_telegram_memberScrape Telegram Member
Retrieves member information from a Telegram group for analytics or monitoring.
POST /scrape_whatsapp
/scrape_whatsappScrape WhatsApp
Extracts data from WhatsApp for various purposes, such as message analysis.
POST /send_whatsapp
/send_whatsappSend WhatsApp Message
Allows for the automated sending of WhatsApp messages.
POST /ssh_command
/ssh_commandSSH Command
Executes SSH commands for remote management of nodes.
POST /change_password
/change_passwordChange Password
Facilitates the changing of passwords for nodes or services within the infrastructure.
Error Handling and Responses
Endpoints return standard HTTP status codes. A 200 OK status indicates success. Client-side errors yield a 4xx status, and server-side issues return a 5xx status, with accompanying error messages to diagnose issues.
Security Measures
Communications with sensitive endpoints (/send_*, /authenticate_with_otp, /change_password) should be encrypted, and access should be tightly controlled. Use rate limiting and logging to prevent abuse.
Rate Limiting
To prevent abuse and ensure fair use, rate limiting is applied to all endpoints. Consult the rate limit policy for details on thresholds and penalties.
Last updated