API Reference
API Overview
Base URL, versioning, and response format for the Cue API.
The Cue API is a REST API that accepts JSON request bodies and returns JSON responses.
Base URL
https://api.oncue.so/v1All endpoints are prefixed with /v1 for API versioning.
Authentication
All requests require a Bearer token in the Authorization header:
Authorization: Bearer cue_sk_your_key_hereSee Authentication for details on getting your API key.
Request format
For POST and PATCH requests, send JSON with the Content-Type header:
curl -X POST https://api.oncue.so/v1/posts \
-H "Authorization: Bearer cue_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"profileId": "prf_123",
"platforms": {
"sac_bluesky1": {
"items": [{ "content": "Hello!" }]
}
}
}'Response format
All responses return JSON with a consistent structure:
Success responses
{
"data": [
{
"id": "pst_abc123",
"socialAccountId": "sac_bluesky1",
"status": "draft"
}
]
}For list endpoints:
{
"data": [
{ "id": "pst_abc123", "status": "draft" },
{ "id": "pst_def456", "status": "scheduled" }
]
}Error responses
{
"error": "Profile not found"
}HTTP status codes
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request (validation error) |
| 401 | Unauthorized (invalid/missing API key) |
| 403 | Forbidden (limit reached) |
| 404 | Resource not found |
| 429 | Rate limit exceeded |
| 500 | Server error |
Rate limiting
API requests are rate limited per API key. See Rate Limiting for limits and headers.
ID prefixes
All resource IDs use prefixes to identify the type:
| Prefix | Resource |
|---|---|
usr_ | User |
prf_ | Profile |
pst_ | Post |
sac_ | Social Account |
med_ | Media Asset |
apk_ | API Key |