Endpoints
Base URL:https://api.apixo.ai/api/v1
Authentication
SendAuthorization: Bearer YOUR_API_KEY. For POST requests, also send Content-Type: application/json. Poll with an API key belonging to the account that submitted the task.
Request body
Parameters
string
default:"async"
Supported values:
async, callback. Use async to poll for the result or callback to receive the terminal result at your receiver.object
required
Provide at least one nonblank prompt, image URL, or video URL. Media URLs must remain accessible until the task finishes.
Responses
The POST response acknowledges the request and returns its task ID.processing, success, or failed. A successful HTTP response can contain a failed task, so check data.state.
data.resultJson once as JSON. The prompt property appears when you supply text. images and videos preserve input order and are empty when you omit their inputs.
A failed item has a
failCode such as INVALID_VIDEO or MODERATION_UNAVAILABLE in place of labels. A partial result uses state: "success" when at least one item completed. If every item fails, the task returns state: "failed", failCode, and failMsg in place of resultJson.
Polling
Use callback mode if you want a terminal notification. After a status timeout, check the same task ID before submitting again.
Billing
A request with one prompt, one image, and one video totals $0.005 at standard prices. Completed items are billable whether flagged or clear. Failed items are refunded. Account pricing and platform rounding may affect the final charge. See API pricing.