REST API

DuckTape's REST API allows developers to programmatically access its features. Alternatively, you can use the DuckTape command line or natural language commands for quick interactions.

Base URL

All API requests are made to the following base URL:

https://api.ducktapeai.com/v1

Authentication

All requests require an API key for authentication. Include the API key in the Authorization header:

curl -X GET https://api.ducktapeai.com/v1/reminders \
     -H "Authorization: Bearer YOUR_API_KEY"

Endpoints

Reminders

Manage reminders using the following endpoints:

Method Endpoint Description
GET /reminders Retrieve a list of reminders
POST /reminders Create a new reminder
GET /reminders/{id} Retrieve a specific reminder
PUT /reminders/{id} Update a reminder
DELETE /reminders/{id} Delete a reminder

Notes

Manage notes using the following endpoints:

Method Endpoint Description
GET /notes Retrieve a list of notes
POST /notes Create a new note
GET /notes/{id} Retrieve a specific note
PUT /notes/{id} Update a note
DELETE /notes/{id} Delete a note

Error Handling

The API returns 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

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.