Request Format

How to structure API requests

Request Format

Learn how to structure requests to the APIXO API.

Submit Task Endpoint

POST https://api.apixo.ai/api/v1/generateTask/{model}

Replace {model} with the model ID (e.g., nano-banana, flux-2, sora-2).

Request Headers

Header	Required	Description
`Authorization`	Yes	`Bearer YOUR_API_KEY`
`Content-Type`	Yes	`application/json`

Request Body

{
  "request_type": "async",
  "callback_url": "https://your-server.com/webhook",
  "input": {
    // Model-specific parameters
  }
}

Common Parameters

These parameters apply to all models:

Parameter	Type	Required	Description
`request_type`	string	Yes	How to receive results: `async` or `callback`
`callback_url`	string	No	Webhook URL for callback mode
`input`	object	Yes	Model-specific generation parameters

request_type

Value	Description	Use Case
`async`	Poll for results using the status endpoint	Client-side apps, simple integrations
`callback`	Receive results via webhook POST	Production servers, real-time applications

callback_url

Only required when request_type is callback.

Requirements:

Must be a publicly accessible HTTPS URL
Must respond with HTTP 200 within 30 seconds
Will receive a POST request with the task result

Input Parameters

The input object contains model-specific parameters. Common ones include:

Parameter	Type	Models	Description
`mode`	string	All	Generation mode (e.g., `text-to-image`)
`prompt`	string	All	Text description of desired output
`image_urls`	string[]	Image models	Reference images for editing
`aspect_ratio`	string	Most	Output dimensions ratio

See individual model documentation for complete parameter lists.

Example Requests

Async Mode (Polling)

curl -X POST https://api.apixo.ai/api/v1/generateTask/nano-banana \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "text-to-image",
      "prompt": "A futuristic city at sunset",
      "aspect_ratio": "16:9"
    }
  }'

Callback Mode (Webhooks)

curl -X POST https://api.apixo.ai/api/v1/generateTask/nano-banana \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "callback",
    "callback_url": "https://your-server.com/webhook/apixo",
    "input": {
      "mode": "text-to-image",
      "prompt": "A futuristic city at sunset",
      "aspect_ratio": "16:9"
    }
  }'

Query Status Endpoint

GET https://api.apixo.ai/api/v1/statusTask/{model}?taskId={taskId}

Parameter	Type	Required	Description
`model`	path	Yes	Model ID used for generation
`taskId`	query	Yes	Task ID from submission response

curl "https://api.apixo.ai/api/v1/statusTask/nano-banana?taskId=task_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Request Format

On this page