Response Format

Understanding API responses and task states

Response Format

All APIXO API responses follow a consistent JSON structure.

Response Structure

{
  "code": 200,
  "message": "success",
  "data": {
    // Response payload
  }
}

Field	Type	Description
`code`	integer	HTTP status code
`message`	string	Human-readable status message
`data`	object	Response payload (varies by endpoint)

Task Submission Response

When you submit a generation task:

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

Field	Type	Description
`taskId`	string	Unique identifier for tracking the task

Save the taskId to query status or debug issues later.

Task Status Response

Task States

State	Description
`pending`	Task received, waiting to be processed
`processing`	Task is being processed by the AI model
`success`	Generation completed successfully
`failed`	Generation failed (see error details)

Pending / Processing

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_abc123xyz789",
    "state": "processing",
    "createTime": 1704067200000
  }
}

Success

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_abc123xyz789",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://cdn.apixo.ai/output/abc123.jpg\"]}",
    "costTime": 12500,
    "createTime": 1704067200000,
    "completeTime": 1704067212500
  }
}

Field	Type	Description
`taskId`	string	Task identifier
`state`	string	`success`
`resultJson`	string	JSON string containing result URLs
`costTime`	integer	Processing time in milliseconds
`createTime`	integer	Task creation timestamp (Unix ms)
`completeTime`	integer	Task completion timestamp (Unix ms)

Parsing resultJson:

const result = JSON.parse(data.resultJson);
const urls = result.resultUrls; // Array of generated content URLs

Failed

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_abc123xyz789",
    "state": "failed",
    "failCode": "CONTENT_VIOLATION",
    "failMsg": "Content violates usage policy",
    "createTime": 1704067200000,
    "completeTime": 1704067205000
  }
}

Field	Type	Description
`failCode`	string	Error code for programmatic handling
`failMsg`	string	Human-readable error message

Result URLs

The resultUrls array contains direct links to generated content:

{
  "resultUrls": [
    "https://cdn.apixo.ai/output/abc123.jpg",
    "https://cdn.apixo.ai/output/abc124.jpg"
  ]
}

Important: Result URLs expire after 24 hours. Download and store important outputs.

Polling Example

async function waitForResult(model, taskId, apiKey) {
  const maxAttempts = 60;
  const pollInterval = 3000; // 3 seconds
  
  for (let i = 0; i < maxAttempts; i++) {
    const response = await fetch(
      `https://api.apixo.ai/api/v1/statusTask/${model}?taskId=${taskId}`,
      { headers: { 'Authorization': `Bearer ${apiKey}` } }
    );
    
    const { data } = await response.json();
    
    switch (data.state) {
      case 'success':
        return JSON.parse(data.resultJson).resultUrls;
      case 'failed':
        throw new Error(`${data.failCode}: ${data.failMsg}`);
      default:
        await new Promise(r => setTimeout(r, pollInterval));
    }
  }
  
  throw new Error('Timeout waiting for result');
}

HTTP Status Codes

Code	Meaning
`200`	Success
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid API key
`403`	Forbidden - Insufficient permissions
`404`	Not Found - Task or model not found
`429`	Too Many Requests - Rate limit exceeded
`500`	Server Error - Try again later

See Error Codes for detailed error handling.

Response Format

On this page