View on GitHub

API Overview

DuckTape's API provides powerful tools for developers to integrate its features into their applications. Additionally, you can use the DuckTape command line or natural language commands for quick interactions.

Available APIs

REST API

Access DuckTape's features programmatically using standard HTTP methods.

Learn More

WebSocket API

Enable real-time communication with DuckTape for interactive applications.

Learn More

Authentication

All API requests require authentication using an API key. You can generate an API key from your DuckTape account dashboard.

# Example of setting an API key in a request
curl -X GET https://api.ducktapeai.com/v1/reminders \
     -H "Authorization: Bearer YOUR_API_KEY"

Rate Limits

To ensure fair usage, DuckTape enforces rate limits on API requests:

  • Standard Plan: 100 requests per minute
  • Pro Plan: 1,000 requests per minute
  • Enterprise Plan: Custom limits
Note: Exceeding the rate limit will result in a 429 Too Many Requests response. Upgrade your plan for higher limits.

Error Handling

DuckTape APIs return standard HTTP status codes to indicate the success or failure of a request:

Status Code Description
200 OK Request was successful
400 Bad Request Invalid request parameters
401 Unauthorized Missing or invalid API key
403 Forbidden Insufficient permissions
404 Not Found Resource not found
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Server encountered an error

Next Steps

Explore the detailed documentation for each API: