Getting Started with Queue-Craft API
Welcome to the Queue-Craft API! This guide will help you get up and running quickly.
Base URL
All API requests should be made to:
https://api.queue-craft.com/api/
API Key
To use the Queue-Craft API, you'll need an API key. You can generate one from your account settings.
Your First Request
Here's how to make your first API call to get your user information:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.queue-craft.com/api/auth/user
Authentication Guide
Bearer Token Authentication
The Queue-Craft API uses Bearer token authentication. Include your API key in the Authorization header of all requests:
Authorization: Bearer YOUR_API_KEY
OAuth 2.0 Flow
For third-party applications, we support OAuth 2.0 authorization code flow:
- Authorization: Direct users to our authorization endpoint
- Callback: Handle the callback with the authorization code
- Token Exchange: Exchange the code for an access token
- API Access: Use the access token to make API requests
Team Context
For team-based operations, include the team ID in your requests:
X-Team-Id: team_123
Or as a query parameter:
GET /api/posts?teamId=team_123
Code Examples
JavaScript/Node.js
// Using fetch
const response = await fetch('https://api.queue-craft.com/api/posts', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
'X-Team-Id': 'team_123'
},
body: JSON.stringify({
content: 'Hello from Queue-Craft API!',
platforms: ['twitter', 'linkedin'],
scheduledAt: '2025-02-01T10:00:00Z'
})
});
const data = await response.json();
console.log('Post created:', data.post);
Python
import requests
url = "https://api.queue-craft.com/api/posts"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
"X-Team-Id": "team_123"
}
data = {
"content": "Hello from Queue-Craft API!",
"platforms": ["twitter", "linkedin"],
"scheduledAt": "2025-02-01T10:00:00Z"
}
response = requests.post(url, json=data, headers=headers)
print("Post created:", response.json()["post"])
cURL
curl -X POST https://api.queue-craft.com/api/posts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-H "X-Team-Id: team_123" \
-d '{
"content": "Hello from Queue-Craft API!",
"platforms": ["twitter", "linkedin"],
"scheduledAt": "2025-02-01T10:00:00Z"
}'
Ruby
require 'net/http'
require 'json'
uri = URI('https://api.queue-craft.com/api/posts')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request['X-Team-Id'] = 'team_123'
request.body = {
content: 'Hello from Queue-Craft API!',
platforms: ['twitter', 'linkedin'],
scheduledAt: '2025-02-01T10:00:00Z'
}.to_json
response = http.request(request)
puts "Post created: #{JSON.parse(response.body)['post']}"
Error Codes Reference
The Queue-Craft API uses standard HTTP status codes and returns detailed error information in the response body.
Error Response Format
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"details": {
"field": "email",
"error": "Invalid email format"
},
"documentation": "https://docs.queue-craft.com/errors/VALIDATION_ERROR"
}
}
Common Error Codes
| HTTP Status | Error Code | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | Request validation failed. Check the details field for specific issues. |
| 401 | UNAUTHORIZED | Authentication required or invalid credentials provided. |
| 403 | FORBIDDEN | You don't have permission to access this resource. |
| 403 | TEAM_SEATS_EXCEEDED | Cannot add member: team has reached its seat limit. |
| 404 | NOT_FOUND | The requested resource was not found. |
| 429 | RATE_LIMIT_EXCEEDED | Too many requests. Please retry after the time specified in the Retry-After header. |
| 500 | INTERNAL_ERROR | An unexpected error occurred. Please try again later. |
| 503 | SERVICE_UNAVAILABLE | The service is temporarily unavailable. Please try again later. |
Rate Limits & Quotas
⚠️ Rate Limiting Overview
To ensure fair usage and maintain service quality, the Queue-Craft API implements rate limiting on all endpoints.
Rate Limit Headers
Every API response includes headers with rate limit information:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200
Rate Limits by Endpoint Category
| Category | Limit | Window | Description |
|---|---|---|---|
| Team Operations | 100 requests | per hour | Team management, member invitations |
| Member Management | 50 invites | per day | Team member invitations |
| API Calls | 10,000 requests | per hour | General API calls per team |
| Post Creation | 500 posts | per hour | Creating and scheduling posts |
| Media Upload | 100 files | per hour | Media file uploads |
| AI Generation | Based on tier | per month | AI content generation requests |
| Webhook Deliveries | 1,000 events | per hour | Webhook event deliveries per team |
Handling Rate Limits
When you exceed a rate limit, you'll receive a 429 response:
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Please retry after 300 seconds.",
"details": {
"limit": 100,
"remaining": 0,
"reset": 1640995200
}
}
}
Best Practices
- Implement exponential backoff when retrying failed requests
- Cache responses when possible to reduce API calls
- Use bulk endpoints for batch operations
- Monitor the rate limit headers to avoid hitting limits
- Contact support for higher limits if needed