Orders, the reports people send back, and your own numbers.
Authenticate with Authorization: Bearer ow_….
The machine-readable document is at /api/docs/openapi.json
(OpenAPI 3.1, version 1.0.0).
/api/v1/services
The catalogue
Every service you may order, with its price per 1000 and its bounds, in catalogue order. The price is USD and the bounds are units; a Custom Task may set its own price per unit instead. catalog places each service in the tree (section, optional category), with titles and descriptions in both languages; icon_url is relative to this host.
/api/v1/orders
Place an order
Charges the balance and creates the task in one transaction: either you are charged and the task exists, or neither happened. Send idempotency_key and a retry of the same request returns the same order rather than buying twice.
/api/v1/orders
Your orders
Newest first. remains is what has not been delivered yet.
/api/v1/orders/{id}
One order
The counters, the charge as it stands now, and the task behind it.
/api/v1/orders/{id}/cancel
Stop an order
A REQUEST, not an instant stop. Nothing new is handed out from this moment; slots already held run to their verdict, and the order becomes Partial or Canceled when the last one lands. What was not delivered is refunded.
/api/v1/balance
Your balance
USD, as the ledger has it right now.
/api/v1/submissions
Reports waiting for you
Across every order. awaiting means somebody has to decide: a first report, one being looked at, or a corrected one that came back.
/api/v1/orders/{id}/submissions
Reports on one order
The same list, narrowed to one order.
/api/v1/submissions/{id}
One report, with its thread
The conversation as the person sees it, their proof, and what our model made of it. allowed is what you may decide right now and refusal says why the rest are not there.
/api/v1/submissions/{id}/verdict
Decide a report
Approve it, ask for a fix, or refuse it. A refusal of the DECISION is 200 with applied: false, not an error: "you cannot reject a report nobody has asked to fix" is an answer, and retrying it will not change it. Asking for a fix or refusing needs a message — the person reads it.
/api/v1/submissions/{id}/messages
Say something without deciding
Goes into the same thread the person reads in the wall. They see it.
/api/v1/me/usage/ai
What the model did with your reports
Not a bill — you pay for completions, and what a check costs is ours. This is here so you can see whether automatic checking is doing anything for you.
/api/v1/webhooks
Your webhooks
With the last delivery’s outcome, so a broken endpoint is visible here.
/api/v1/webhooks
Register a webhook
The signing secret comes back once, in this response. Store it: every delivery is signed with it, and we cannot show it to you again.
/api/v1/webhooks/{id}
Pause one, or change its events
Pausing beats deleting: the secret is shown once, so a delete is a re-key for every consumer of it. A paused endpoint receives nothing and keeps everything.
/api/v1/webhooks/{id}/deliveries
What we sent to this endpoint
Every attempt, with your server’s answer and the exact body we sent. The last 50, newest first.
/api/v1/webhooks/{id}/deliveries/{deliveryId}/resend
Send one again
Starts the schedule again from the first attempt. This is what the stored body is for: an endpoint that was down all afternoon has run out of attempts, and the alternative is reconciling by hand. A disabled webhook answers 409: enable it first.
/api/v1/webhooks/{id}
Remove a webhook
Its delivery history goes with it.
/api/v1/placements/{key}/stats
What your wall earned
Conversions, revenue, reversals, and both halves of what we owe you.
/api/v1/placements/{key}/postbacks
What we sent you
Every notification, every attempt, and what your server answered.
/api/v1/placements/{key}/postbacks/{deliveryId}/resend
Send one again
Restarts the retry schedule from the first attempt.
/api/v1/placements/{key}/postbacks/test
Send a test one
A real request to your configured URL, with a real signature. It carries payout=0 and amount=0, so a handler that credits without reading event credits nothing.
/api/v1/placements/{key}/users/{externalId}
One of your users
By YOUR id for them — the one you sent us in the loader. Their counters, what they earned, and the fraud flags our checks raised.
Translate by code, never by message — the message is the English
default and may be reworded.
| code | status | meaning |
|---|---|---|
validation_failed | 400 | Request validation failed |
unauthorized | 401 | Authentication required |
forbidden | 403 | Not allowed |
not_found | 404 | Not found |
conflict | 409 | Conflict with the current state |
rate_limited | 429 | Too many requests |
payload_too_large | 413 | Request body is too large |
internal | 500 | Internal error |
ai_unavailable | 503 | The model is not available |
comments_unavailable | 503 | Automatic comments are not available right now |
ai_models_not_chosen | 409 | Pick a real model for every tier before checking is switched on |
ai_check_unavailable | 409 | This report cannot be sent to the model |
ai_key_missing | 409 | This server has no AI provider key |
project_locked | 409 | The project changed status while it was being edited |
icon_invalid | 400 | Expected a PNG, JPEG, WebP, GIF or SVG image within the size limit |
placement_not_found | 404 | Unknown placement |
placement_inactive | 403 | Placement is not active |
invalid_signature | 401 | Invalid user signature |
signature_required | 401 | The wall opens only with a signed user id: sig = HMAC-SHA256(user_id:ts) and ts |
signature_expired | 401 | The signed link has expired; open the wall again |
placeholder_user_id | 400 | user_id is the template placeholder; put the real user id there |
user_banned | 403 | User is banned by the publisher |
session_expired | 401 | Session expired |
task_not_available | 409 | Task is not available |
task_already_reserved | 409 | Task already reserved |
per_user_limit_reached | 409 | Task limit reached for this user |
no_slots | 409 | No free slots left |
target_already_done | 409 | You already did this task for this target on an earlier order |
account_required | 409 | Link your account on this platform first |
account_script_mismatch | 409 | This task is not available for your linked account |
account_already_done | 409 | Your linked account has already done this task |
account_input_invalid | 400 | Paste a channel id, a channel link or a profile link |
account_not_found | 404 | The platform has no such account |
account_private | 400 | Make your subscriptions public on YouTube and try again |
account_taken | 409 | This account is already linked by another person |
account_already_linked | 409 | You already have a linked account on this platform |
account_link_cooldown | 429 | Please wait before trying to link an account again |
api_check_limit_reached | 429 | You have started as many API-checked tasks as allowed for now |
api_unavailable | 503 | The platform cannot be asked right now |
reservation_not_found | 404 | Reservation not found |
reservation_expired | 410 | Reservation has expired |
stage_not_started | 409 | Start the stage before sending its report |
stage_not_open | 409 | The stage has not opened yet |
stage_not_startable | 409 | There is no stage to start |
submission_not_editable | 409 | Submission cannot be changed in its current status |
revision_deadline_passed | 410 | Revision deadline has passed |
attachment_required | 400 | A proof attachment is required |
proof_field_required | 400 | The report is missing a required proof field |
attachment_too_large | 413 | Attachment is too large |
attachment_type_not_allowed | 415 | Attachment type is not allowed |
attachment_unreadable | 415 | Attachment could not be read |
too_many_attachments | 400 | Too many attachments |
insufficient_funds | 402 | Insufficient balance |
order_target_busy | 409 | There is an active order for this target already; a new one can be placed when it is completed |
refill_not_available | 409 | Refill is not available for this order |
refill_in_progress | 409 | A refill of this order is in progress |
refill_too_soon | 409 | A refill of this order was requested recently |
refill_temporarily_unavailable | 503 | The platform did not answer; try the refill again later |
adjustment_above_max | 400 | The adjustment is above the configured maximum |
service_unavailable | 409 | Service is not available |
invalid_quantity | 400 | Quantity is out of the allowed range |
verdict_not_allowed | 409 | This verdict is not allowed at this stage |
wrong_cabinet | 403 | This address belongs to a different cabinet |
email_not_verified | 403 | Confirm your email address first |
api_scope_not_allowed | 403 | This account cannot hold an API key with these scopes |
invalid_token | 400 | This link or code is no longer valid |
two_factor_required | 401 | A sign-in code is required |