Generate Task

Submit asynchronous image, video, audio, or utility model tasks with model-specific input and polling or webhook delivery

Submit a generation task to any supported AI model.

Endpoint

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

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

Headers

Authorization · string · required

Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Content-Type · string · required

Must be application/json.

Request Body

request_type · string · default: "async" · required

How to receive results. async for polling via the status endpoint, callback for webhook delivery.

callback_url · string

Webhook URL for receiving results. Required when request_type is callback. Must be a publicly accessible HTTPS URL that responds with HTTP 200 within 30 seconds. See Webhooks for details.

input · object · required

Model-specific generation parameters.

Show Common fields

mode · string · required

Generation mode (e.g., text-to-image, image-to-image, text-to-video).

prompt · string · required

Text description of the desired output.

image_urls · string[]

Reference images for editing modes (e.g., image-to-image).

aspect_ratio · string

Output dimensions ratio (e.g., 1:1, 16:9, 9:16).

See individual model documentation for complete parameter lists, or the Parameter Specification for all common fields.

Response

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_abc123xyz789"
  }
}

code · integer

HTTP status code.

message · string

Human-readable status message.

data · object

Show properties

taskId · string

Unique identifier for tracking the task. Use this to query status.

Save the taskId — you’ll need it to query status or debug issues later.

Examples

Async Mode (Polling)

cURL

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"
    }
  }'

JavaScript

const response = await fetch('https://api.apixo.ai/api/v1/generateTask/nano-banana', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    request_type: 'async',
    input: {
      mode: 'text-to-image',
      prompt: 'A futuristic city at sunset',
      aspect_ratio: '16:9',
    },
  }),
});

const { data } = await response.json();
console.log('Task ID:', data.taskId);

Python

import requests

response = requests.post(
    'https://api.apixo.ai/api/v1/generateTask/nano-banana',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'request_type': 'async',
        'input': {
            'mode': 'text-to-image',
            'prompt': 'A futuristic city at sunset',
            'aspect_ratio': '16:9',
        },
    }
)

task_id = response.json()['data']['taskId']
print(f'Task ID: {task_id}')

Callback Mode (Webhooks)

cURL

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"
    }
  }'

JavaScript

const response = await fetch('https://api.apixo.ai/api/v1/generateTask/nano-banana', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    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',
    },
  }),
});

Python

response = requests.post(
    'https://api.apixo.ai/api/v1/generateTask/nano-banana',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        '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',
        },
    }
)

Error Responses

Code	Description
400	Invalid request parameters
401	Invalid or missing API key
403	Insufficient permissions
429	Rate limit exceeded
500	Server error

See Errors for detailed error handling.