Initiates data collection and processing for a specific OnlyFans account. This endpoint queues a task to collect metrics, content information, and subscriber data.
Endpoint
POST /v1/accounts/{id}/process
Authentication
This endpoint requires authentication with a valid API token having the write:accounts
permission.
# Available URLs:
# - Local development: http://localhost:3000/v1/accounts/550e8400-e29b-41d4-a716-446655440000/process
# - Alternative local: http://localhost:3001/v1/accounts/550e8400-e29b-41d4-a716-446655440000/process
# - Production: https://onlyautomator.com/v1/accounts/550e8400-e29b-41d4-a716-446655440000/process
# Example with curl:
curl -X POST "https://onlyautomator.com/v1/accounts/550e8400-e29b-41d4-a716-446655440000/process" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"priority": 1,
"forceUpdate": true
}'
URL Parameters
The unique identifier of the account to process
Request Body
Priority level for the task (1-5, with 1 being highest priority). Default: 3
Whether to force a full update even if data is recent. Default: false
Response
Status of the request (“success” or “error”)
Unique identifier for the created task
Estimated ISO timestamp for task completion
202 Accepted
{
"status": "success",
"taskId": "task_8f9a12b3",
"estimatedCompletion": "2023-04-01T12:15:00Z"
}
400 Bad Request
{
"error": {
"code": "invalid_parameter",
"message": "The parameter 'priority' must be between 1 and 5",
"details": {
"parameter": "priority"
}
}
}
401 Unauthorized
{
"error": {
"code": "authentication_required",
"message": "Authentication is required to access this resource"
}
}
403 Forbidden
{
"error": {
"code": "permission_denied",
"message": "Your API token does not have the 'write:accounts' permission"
}
}
404 Not Found
{
"error": {
"code": "resource_not_found",
"message": "The specified account could not be found",
"details": {
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}
}
Error Codes
Error Code | Description |
---|
invalid_parameter | A parameter is missing or invalid |
authentication_required | No valid authentication token provided |
permission_denied | Token lacks required permissions |
resource_not_found | Account ID not found |
service_unavailable | Processing service temporarily unavailable |
processing_in_progress | Account is already being processed |
Notes
- Processing time varies based on account size and system load
- Real-time progress updates can be obtained through the websocket connection
- The system will automatically handle OnlyFans rate limits
- Setting high priority can affect processing of other accounts in your plan
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The unique identifier of the account to process
Priority level for the task (1-5, with 1 being highest priority)
Required range: 1 <= x <= 5
Whether to force a full update even if data is recent