SJinn

https://sjinn.ai/docs
Admin
SJinn is an AI-powered video generation platform that creates stunning videos from text...
Tokens:31,085
Snippets:232
Trust Score:7.4
Update:7 months ago
Show doc for...
Tokens:
Raw
### Veo3 Text-to-Video API Request Examples

Source: https://sjinn.ai/docs/api/tool/veo3-text-to-video

Examples demonstrating how to call the Veo3 Text-to-Video API for creating landscape (16:9) and portrait (9:16) videos. These examples show the required 'tool_type' and 'input' parameters, including 'prompt' and 'aspect_ratio'.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "veo3-text-to-video-fast-api",
    "input": {
      "prompt": "A majestic dragon flying through clouds at sunset, cinematic lighting",
      "aspect_ratio": "16:9"
    }
  }'
```

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "veo3-text-to-video-fast-api",
    "input": {
      "prompt": "A fashion model walking down a runway, professional photography",
      "aspect_ratio": "9:16"
    }
  }'
```

--------------------------------

### Complete Workflow Example in JavaScript

Source: https://sjinn.ai/docs/api/tool

This JavaScript example illustrates a complete workflow using the SJinn Tool API. It includes functions to create a tool task and poll for its completion, handling success and failure scenarios. It utilizes `fetch` for API requests and includes error handling and a timeout mechanism.

```javascript
const API_KEY = 'YOUR_API_KEY';
const BASE_URL = 'https://sjinn.ai/api/un-api';

async function createTask(toolType, input) {
  const response = await fetch(`${BASE_URL}/create_tool_task`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ tool_type: toolType, input }),
  });
  
  const result = await response.json();
  if (!result.success) throw new Error(result.errorMsg);
  return result.data.task_id;
}

async function waitForCompletion(taskId, maxAttempts = 60) {
  for (let i = 0; i < maxAttempts; i++) {
    const response = await fetch(`${BASE_URL}/query_tool_task_status`, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({ task_id: taskId }),
    });
    
    const result = await response.json();
    
    if (result.data.status === 1) return result.data;
    if (result.data.status === -1) throw new Error(result.data.error || 'Task failed');
    
    console.log(`Processing... (${i + 1}/${maxAttempts})`);
    await new Promise(resolve => setTimeout(resolve, 10000));
  }
  throw new Error('Timeout waiting for task completion');
}

// Usage
async function runWorkflow() {
  try {
    const taskId = await createTask('veo3-text-to-video-fast-api', {
      prompt: 'A cinematic shot of a dragon flying over mountains',
      aspect_ratio: '16:9',
    });
    const result = await waitForCompletion(taskId);
    console.log('Output:', result.output_urls[0]);
  } catch (error) {
    console.error('Workflow failed:', error);
  }
}

runWorkflow();

```

--------------------------------

### Veo3 Text-to-Video API Request using Python

Source: https://sjinn.ai/docs/api/tool/veo3-text-to-video

A Python example using the `requests` library to make a POST request to the Veo3 Text-to-Video API. It demonstrates setting up the URL, headers, and the JSON payload for the API call.

```python
import requests

url = 'https://sjinn.ai/api/un-api/create_tool_task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'tool_type': 'veo3-text-to-video-fast-api',
    'input': {
        'prompt': 'A majestic dragon flying through clouds at sunset, cinematic lighting',
        'aspect_ratio': '16:9'
    }
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print('Task ID:', result['data']['task_id'])
```

--------------------------------

### Seedream V5 Lite API Response Examples

Source: https://sjinn.ai/docs/api/tool/seedream-v5-lite

Shows example JSON responses for the Seedream V5 Lite API, covering both successful task creation and error scenarios. This helps developers understand the expected output format.

```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "success": false,
  "errorMsg": "prompt is required",
  "error_code": 400
}
```

--------------------------------

### Success Response Example

Source: https://sjinn.ai/docs/api/tool/seedream-v4-5

Example of a successful response from the SJinn AI API after creating a tool task. It indicates success, provides an empty error message, and includes a task ID for tracking.

```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

```

--------------------------------

### Veo3 Image-to-Video API Request (JavaScript)

Source: https://sjinn.ai/docs/api/tool/veo3-image-to-video

Shows how to initiate a video generation task using the Veo3 Image-to-Video tool with JavaScript's Fetch API. This example demonstrates sending the necessary JSON payload to the API endpoint.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'veo3-image-to-video-fast-api',
    input: {
      prompt: 'The person smiles and waves at the camera',
      image: 'https://cdn.sjinn.ai/uploads/portrait.jpg',
      aspect_ratio: '16:9',
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);

```

--------------------------------

### Image Generation Tool

Source: https://sjinn.ai/docs/agent-guide/SJinn-Agent-Guide

Utilize the Image_Generation tool to create images from text prompts. This tool currently defaults to the Nano-Banana Pro model for image synthesis.

```python
Image_Generation("A futuristic cityscape at sunset")
```

--------------------------------

### Sora2 Image-to-Video API Error Response Example

Source: https://sjinn.ai/docs/api/tool/sora2-image-to-video

Example of an error response from the Sora2 Image-to-Video API. It indicates failure, provides an error message explaining the issue (e.g., missing required parameter), and a corresponding error code.

```json
{
  "success": false,
  "errorMsg": "image is required",
  "error_code": 400
}
```

--------------------------------

### Multi-Image Reference Editing (cURL)

Source: https://sjinn.ai/docs/api/tool/nano-banana-image

Example using cURL to perform image editing with multiple reference images. This demonstrates sending a prompt, an array of image URLs, and the desired aspect ratio for the task.

```bash
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "nano-banana-image-api",
    "input": {
      "prompt": "A futuristic cityscape at night with neon lights",
      "image_list": ["https://cdn.sjinn.ai/uploads/style1.jpg", "https://cdn.sjinn.ai/uploads/style2.jpg"],
      "aspect_ratio": "16:9"
    }
  }'
```

--------------------------------

### Veo3 Image-to-Video API Request (cURL)

Source: https://sjinn.ai/docs/api/tool/veo3-image-to-video

Demonstrates how to create a video generation task using the Veo3 Image-to-Video tool via a cURL POST request. It shows examples for landscape, portrait, and advanced usage with start and end frames.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "veo3-image-to-video-fast-api",
    "input": {
      "prompt": "The person smiles and waves at the camera",
      "image": "https://cdn.sjinn.ai/uploads/portrait.jpg",
      "aspect_ratio": "16:9"
    }
  }'

curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "veo3-image-to-video-fast-api",
    "input": {
      "prompt": "The model strikes a pose and looks at the camera",
      "image": "https://cdn.sjinn.ai/uploads/model-portrait.jpg",
      "aspect_ratio": "9:16"
    }
  }'

curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "veo3-image-to-video-fast-api",
    "input": {
      "prompt": "Smooth transition from day to night",
      "image": "https://cdn.sjinn.ai/uploads/scene-day.jpg",
      "end_image_url": "https://cdn.sjinn.ai/uploads/scene-night.jpg",
      "aspect_ratio": "16:9"
    }
  }'
```

--------------------------------

### POST /api/un-api/create_tool_task

Source: https://sjinn.ai/docs/api/tool/veo3-image-to-video

Creates a video generation task using the Veo3 Image-to-Video model. This endpoint accepts a prompt, a starting image URL, and optional parameters like aspect ratio and an end image URL.

```APIDOC
## POST /api/un-api/create_tool_task

### Description
Generates high-quality videos from images and text descriptions using Google's Veo3 model. Supports setting both start and end frames for more precise video generation control.

### Method
POST

### Endpoint
https://sjinn.ai/api/un-api/create_tool_task

### Parameters
#### Request Body
- **tool_type** (string) - Required - The identifier for the Veo3 Image-to-Video tool (`veo3-image-to-video-fast-api`).
- **input** (object) - Required - Contains the parameters for video generation.
  - **prompt** (string) - Required - Text description of the video content to guide AI video motion and scene generation. Must be a non-empty string.
  - **image** (string) - Required - Image URL for the video's starting frame. Must be a complete HTTP/HTTPS URL.
  - **aspect_ratio** (string) - Optional - The desired aspect ratio for the video. Supported values are "16:9" (landscape) and "9:16" (portrait). Defaults to "16:9".
  - **end_image_url** (string) - Optional - URL for the video's ending frame. If provided, must be a complete HTTP/HTTPS URL. Defaults to an empty string (no end frame).

### Request Example
```json
{
  "tool_type": "veo3-image-to-video-fast-api",
  "input": {
    "prompt": "The camera slowly zooms in while the subject turns to face the viewer",
    "image": "https://cdn.sjinn.ai/uploads/image.jpg",
    "aspect_ratio": "16:9",
    "end_image_url": "https://cdn.sjinn.ai/uploads/end_image.jpg"
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the task creation was successful.
- **errorMsg** (string) - An empty string if successful, otherwise an error message.
- **error_code** (integer) - 0 if successful, otherwise an error code.
- **data** (object) - Contains the task ID.
  - **task_id** (string) - The unique identifier for the generated video task.

#### Error Response (400+)
- **success** (boolean) - Always false.
- **errorMsg** (string) - Description of the error.
- **error_code** (integer) - The HTTP status code or a custom error code.

#### Response Example (Success)
```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
```

#### Response Example (Error)
```json
{
  "success": false,
  "errorMsg": "image is required",
  "error_code": 400
}
```
```

--------------------------------

### Veo3 Image-to-Video API Request (Python)

Source: https://sjinn.ai/docs/api/tool/veo3-image-to-video

Provides a Python example using the `requests` library to send a POST request for video generation via the Veo3 Image-to-Video tool. It includes setting headers and the JSON data payload.

```python
import requests

url = 'https://sjinn.ai/api/un-api/create_tool_task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'tool_type': 'veo3-image-to-video-fast-api',
    'input': {
        'prompt': 'The person smiles and waves at the camera',
        'image': 'https://cdn.sjinn.ai/uploads/portrait.jpg',
        'aspect_ratio': '16:9'
    }
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print('Task ID:', result['data']['task_id'])

```

--------------------------------

### Create Grok Text-to-Video Task (cURL)

Source: https://sjinn.ai/docs/api/tool/grok-text-to-video

Demonstrates how to create a video generation task using the Grok Text-to-Video API via cURL. It includes examples for both short and long video requests, specifying prompt, duration, and aspect ratio.

```bash
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "tool_type": "grok-text-to-video-api", \
    "input": { \
      "prompt": "A cat playing piano in a jazz club, cinematic lighting", \
      "duration": 5, \
      "aspect_ratio": "16:9" \
    } \
  }'
```

```bash
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "tool_type": "grok-text-to-video-api", \
    "input": { \
      "prompt": "A fashion model walking down a runway with dramatic lighting effects", \
      "duration": 15, \
      "aspect_ratio": "9:16" \
    } \
  }'
```

--------------------------------

### Create Grok Image-to-Video Task (cURL)

Source: https://sjinn.ai/docs/api/tool/grok-image-to-video

Example of creating a video generation task using cURL. This demonstrates how to send a POST request to the API with the tool type and input parameters, including prompt, image URL, duration, and aspect ratio.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "tool_type": "grok-image-to-video-api", \
    "input": { \
      "prompt": "The character turns around and smiles at the camera", \
      "image": "https://cdn.sjinn.ai/uploads/character.jpg", \
      "duration": 5, \
      "aspect_ratio": "16:9" \
    } \
  }'
```

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "tool_type": "grok-image-to-video-api", \
    "input": { \
      "prompt": "The model strikes a pose and walks forward confidently", \
      "image": "https://cdn.sjinn.ai/uploads/model-portrait.jpg", \
      "duration": 8, \
      "aspect_ratio": "9:16" \
    } \
  }'
```

--------------------------------

### Sora2 Image-to-Video API Success Response Example

Source: https://sjinn.ai/docs/api/tool/sora2-image-to-video

Example of a successful response from the Sora2 Image-to-Video API after creating a task. It indicates success, provides an empty error message, a zero error code, and a data object containing the unique task ID.

```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
```

--------------------------------

### Edit Image with Reference (cURL)

Source: https://sjinn.ai/docs/api/tool/nano-banana-image

Example using cURL to edit an image with a reference. This showcases how to provide a prompt, a list of image URLs as references, and specify an aspect ratio for the editing task.

```bash
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "nano-banana-image-api",
    "input": {
      "prompt": "Transform into a watercolor painting style",
      "image_list": ["https://cdn.sjinn.ai/uploads/photo.jpg"],
      "aspect_ratio": "1:1"
    }
  }'
```

--------------------------------

### Create Grok Image-to-Video Task (JavaScript)

Source: https://sjinn.ai/docs/api/tool/grok-image-to-video

Example of creating a video generation task using JavaScript's fetch API. This shows how to construct the request body with the tool type and input parameters, including prompt, image URL, duration, and aspect ratio, and send it as a JSON payload.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'grok-image-to-video-api',
    input: {
      prompt: 'The character turns around and smiles at the camera',
      image: 'https://cdn.sjinn.ai/uploads/character.jpg',
      duration: 5,
      aspect_ratio: '16:9',
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);
```

--------------------------------

### Create Image Generation Task (cURL)

Source: https://sjinn.ai/docs/api/tool/nano-banana-image

Example using cURL to create an image generation task. This demonstrates how to send a POST request to the API endpoint with the tool type and input parameters, including the prompt and optional aspect ratio.

```bash
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "nano-banana-image-api",
    "input": {
      "prompt": "A serene Japanese garden with cherry blossoms and a koi pond",
      "aspect_ratio": "16:9"
    }
  }'
```

--------------------------------

### Create Tool Task using JavaScript

Source: https://sjinn.ai/docs/api/tool/seedream-v5-lite

Provides a JavaScript example for interacting with the Seedream V5 Lite API to create an image generation task. It utilizes the fetch API to send a POST request with the necessary headers and JSON payload.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'seedream-v5-lite-api',
    input: {
      prompt: 'A watercolor painting of a mountain village at dawn',
      image_size: '16:9',
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);
```

--------------------------------

### Create Grok Text-to-Video Task (JavaScript)

Source: https://sjinn.ai/docs/api/tool/grok-text-to-video

Provides a JavaScript example for creating a video generation task using the Grok Text-to-Video API. It utilizes the fetch API to send a POST request with the necessary payload, including prompt, duration, and aspect ratio.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'grok-text-to-video-api',
    input: {
      prompt: 'A cat playing piano in a jazz club, cinematic lighting',
      duration: 5,
      aspect_ratio: '16:9',
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);
```

--------------------------------

### Veo3 Text-to-Video API Request using JavaScript

Source: https://sjinn.ai/docs/api/tool/veo3-text-to-video

A JavaScript example using the `fetch` API to send a POST request to the Veo3 Text-to-Video tool endpoint. It includes setting the Authorization header, Content-Type, and the JSON body with 'tool_type' and 'input' parameters.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'veo3-text-to-video-fast-api',
    input: {
      prompt: 'A majestic dragon flying through clouds at sunset, cinematic lighting',
      aspect_ratio: '16:9',
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);
```

--------------------------------

### Create Agent Task

Source: https://sjinn.ai/docs/api/agent

Initiates a new AI Agent task with a given text prompt. You can optionally specify a template ID for guided execution and a quality mode.

```APIDOC
## POST /api/un-api/create_agent_task

### Description
Starts a new AI Agent task with a text prompt. This endpoint allows for guided task execution using templates and quality settings.

### Method
POST

### Endpoint
/api/un-api/create_agent_task

### Parameters
#### Request Body
- **message** (string) - Required - The task description for the AI Agent.
- **template_id** (string) - Optional - Template ID from https://sjinn.ai/templates for guided task execution, e.g. "788acc9a-866b-4688-849e-7c7cfffaff54".
- **quality** (string) - Optional - Quality mode for task execution. Values: "quality" (default, higher quality output) or "cheap" (faster, lower cost).

### Request Example
```json
{
  "message": "Create a video of a cute panda playing with bubbles in a bamboo forest",
  "template_id": "788acc9a-866b-4688-849e-7c7cfffaff54",
  "quality": "quality"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request was successful.
- **errorMsg** (string) - Error message if failed.
- **error_code** (number) - Error code (0 for success).
- **data.project_id** (string) - Unique project identifier.
- **data.chat_id** (string) - Unique chat/task identifier for status queries.

#### Response Example
```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "project_id": "550e8400-e29b-41d4-a716-446655440000",
    "chat_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  }
}
```
```

--------------------------------

### Visual Question Answering Tool

Source: https://sjinn.ai/docs/agent-guide/SJinn-Agent-Guide

Use the Image_VQA tool to analyze images and answer questions about their content. This tool is useful for tasks such as scene description and object identification within an image.

```python
Image_VQA(image="path/to/image.jpg", question="What is the main object in this image?")
```

--------------------------------

### Create Image Generation Task (Python)

Source: https://sjinn.ai/docs/api/tool/nano-banana-image

Example using Python's requests library to create an image generation task. This demonstrates sending a POST request with custom headers and a JSON payload to the API endpoint.

```python
import requests

url = 'https://sjinn.ai/api/un-api/create_tool_task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'tool_type': 'nano-banana-image-api',
    'input': {
        'prompt': 'A serene Japanese garden with cherry blossoms and a koi pond',
        'image_list': ['https://cdn.sjinn.ai/uploads/reference.jpg'],
        'aspect_ratio': '16:9'
    }
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print('Task ID:', result['data']['task_id'])
```

--------------------------------

### Create Sora2 Image-to-Video Task (JavaScript)

Source: https://sjinn.ai/docs/api/tool/sora2-image-to-video

Example JavaScript code using the Fetch API to create a video generation task with the Sora2 Image-to-Video API. It demonstrates setting up headers, the request body with tool type and input parameters, and logging the task ID from the response.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'sora2-image-to-video-api',
    input: {
      prompt: 'The person turns their head and smiles at the camera',
      image: 'https://cdn.sjinn.ai/uploads/portrait.jpg',
      aspect_ratio: '16:9',
      mode: 'std',
      duration: 10,
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);
```

--------------------------------

### Create Text-to-Video Task (cURL)

Source: https://sjinn.ai/docs/api/tool/sora2-text-to-video

Example cURL requests to create a text-to-video task using the Sora2 API. Demonstrates both default 'Std' mode and 'Pro' mode for higher quality generation. Requires an API key for authentication.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "sora2-text-to-video-api",
    "input": {
      "prompt": "A time-lapse of a flower blooming in a garden",
      "aspect_ratio": "16:9",
      "duration": 10
    }
  }'

curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "sora2-text-to-video-api",
    "input": {
      "prompt": "A cinematic aerial shot of a mountain landscape at golden hour",
      "aspect_ratio": "16:9",
      "mode": "pro",
      "duration": 15
    }
  }'
```

--------------------------------

### Specify Video Generation Model

Source: https://sjinn.ai/docs/agent-guide/SJinn-Agent-Guide

Instruct SJinn Agent to use specific video generation models like Sora2 or Veo3. This is done via direct commands within the conversation. Currently, only Sora2 and Veo3 can be manually specified; other models are auto-selected.

```text
"Use Sora2"
"Use Veo3"
```

--------------------------------

### Create Image Generation Task (JavaScript)

Source: https://sjinn.ai/docs/api/tool/nano-banana-image

Example using JavaScript's fetch API to create an image generation task. This code sends a POST request to the API with the necessary headers and a JSON body containing the tool type and input parameters.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_tool_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    tool_type: 'nano-banana-image-api',
    input: {
      prompt: 'A serene Japanese garden with cherry blossoms and a koi pond',
      aspect_ratio: '16:9',
    },
  }),
});

const result = await response.json();
console.log('Task ID:', result.data.task_id);
```

--------------------------------

### Grok Image-to-Video API

Source: https://sjinn.ai/docs/api/tool/grok-image-to-video

The Grok Image-to-Video tool uses xAI's Grok Imagine Video model to generate high-quality video content from a starting image and text description. It supports flexible video duration (3-15 seconds) and multiple aspect ratios.

```APIDOC
## POST /api/un-api/create_tool_task

### Description
Generates a video from a static image using the Grok Image-to-Video model.

### Method
POST

### Endpoint
/api/un-api/create_tool_task

### Parameters
#### Request Body
- **tool_type** (string) - Required - The identifier for the Grok Image-to-Video tool (`grok-image-to-video-api`).
- **input** (object) - Required - Contains the parameters for video generation.
  - **prompt** (string) - Required - Text description of the desired motion and video content. Focus on describing the movement rather than the image contents.
  - **image** (string) - Required - Image URL for the video's starting frame. Must be a complete HTTP/HTTPS URL.
  - **duration** (number) - Optional - The desired duration of the video in seconds. Defaults to 5. Range: 3-15. Values outside this range will default to 5.
  - **aspect_ratio** (string) - Optional - The aspect ratio of the video. Defaults to "16:9". Supported values: "16:9", "9:16", "1:1". Invalid values default to "16:9".

### Request Example
```json
{
  "tool_type": "grok-image-to-video-api",
  "input": {
    "prompt": "The character turns around and smiles at the camera",
    "image": "https://cdn.sjinn.ai/uploads/character.jpg",
    "duration": 5,
    "aspect_ratio": "16:9"
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **errorMsg** (string) - An empty string if the request was successful.
- **error_code** (number) - 0 if the request was successful.
- **data** (object) - Contains the task ID for the video generation.
  - **task_id** (string) - The unique identifier for the video generation task.

#### Error Response (400+)
- **success** (boolean) - Indicates if the request was successful (will be false).
- **errorMsg** (string) - A message describing the error.
- **error_code** (number) - The error code.

### Response Example (Success)
```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
```

### Response Example (Error)
```json
{
  "success": false,
  "errorMsg": "image is required",
  "error_code": 400
}
```
```

--------------------------------

### Create Sora2 Image-to-Video Task (Python)

Source: https://sjinn.ai/docs/api/tool/sora2-image-to-video

Example Python code using the requests library to create a video generation task with the Sora2 Image-to-Video API. It shows how to define the URL, headers, JSON payload with tool type and input parameters, and print the task ID from the JSON response.

```python
import requests

url = 'https://sjinn.ai/api/un-api/create_tool_task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'tool_type': 'sora2-image-to-video-api',
    'input': {
        'prompt': 'The person turns their head and smiles at the camera',
        'image': 'https://cdn.sjinn.ai/uploads/portrait.jpg',
        'aspect_ratio': '16:9',
        'mode': 'pro',
        'duration': 15
    }
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print('Task ID:', result['data']['task_id'])
```

--------------------------------

### Error Response Example

Source: https://sjinn.ai/docs/api/tool/seedream-v4-5

Example of an error response from the SJinn AI API. It indicates failure, provides an error message explaining the issue (e.g., missing required parameter), and includes an error code.

```json
{
  "success": false,
  "errorMsg": "prompt is required",
  "error_code": 400
}

```

--------------------------------

### Create Grok Image-to-Video Task (Python)

Source: https://sjinn.ai/docs/api/tool/grok-image-to-video

Example of creating a video generation task using Python's requests library. This demonstrates how to set up the request URL, headers, and JSON payload containing the tool type and input parameters like prompt, image URL, duration, and aspect ratio.

```python
import requests

url = 'https://sjinn.ai/api/un-api/create_tool_task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'tool_type': 'grok-image-to-video-api',
    'input': {
        'prompt': 'The character turns around and smiles at the camera',
        'image': 'https://cdn.sjinn.ai/uploads/character.jpg',
        'duration': 5,
        'aspect_ratio': '16:9'
    }
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print('Task ID:', result['data']['task_id'])
```

--------------------------------

### Create Tool Task using Python

Source: https://sjinn.ai/docs/api/tool/seedream-v5-lite

Illustrates how to create an image generation task using the Seedream V5 Lite API with Python's requests library. It demonstrates setting up the request URL, headers, and JSON data for the POST request.

```python
import requests

url = 'https://sjinn.ai/api/un-api/create_tool_task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'tool_type': 'seedream-v5-lite-api',
    'input': {
        'prompt': 'A watercolor painting of a mountain village at dawn',
        'image_size': '16:9'
    }
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print('Task ID:', result['data']['task_id'])
```

--------------------------------

### Query Agent Task Status with cURL

Source: https://sjinn.ai/docs/api/agent

Checks the status and results of an AI Agent task using a cURL command. Supports both POST and GET methods. The GET method requires the chat_id and optionally accepts tool_names to filter results. Authentication is handled via a Bearer token.

```shell
curl -X GET "https://sjinn.ai/api/un-api/query_agent_task_status?chat_id=6ba7b810-9dad-11d1-80b4-00c04fd430c8&tool_names=SJinn_Image_Edit,ffmpeg_full_compose" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Text-to-Image Generation Request (cURL)

Source: https://sjinn.ai/docs/api/tool/seedream-v4-5

Example cURL request for generating an image from a text prompt without using reference images. It specifies the tool type, prompt, and aspect ratio.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "tool_type": "seedream-v4-5-api", \
    "input": { \
      "prompt": "A futuristic cyberpunk cityscape at night with neon lights", \
      "aspect_ratio": "16:9" \
    } \
  }'
```

--------------------------------

### Image Editing with Reference Request (cURL)

Source: https://sjinn.ai/docs/api/tool/seedream-v4-5

Example cURL request for editing an image using a reference image and a text prompt. It includes the prompt, a list of image URLs, and the desired aspect ratio.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "tool_type": "seedream-v4-5-api", \
    "input": { \
      "prompt": "Transform into an oil painting style with warm tones", \
      "image_list": ["https://cdn.sjinn.ai/uploads/photo.jpg"], \
      "aspect_ratio": "1:1" \
    } \
  }'
```

--------------------------------

### Create Tool Task using cURL

Source: https://sjinn.ai/docs/api/tool/seedream-v5-lite

Demonstrates how to create an image generation or editing task using the Seedream V5 Lite API via cURL. It shows examples for both text-to-image and image editing with reference images.

```curl
curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "seedream-v5-lite-api",
    "input": {
      "prompt": "A watercolor painting of a mountain village at dawn",
      "image_size": "16:9"
    }
  }'

curl -X POST https://sjinn.ai/api/un-api/create_tool_task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "seedream-v5-lite-api",
    "input": {
      "prompt": "Add a rainbow in the sky and make the colors more vibrant",
      "image_list": ["https://cdn.sjinn.ai/uploads/landscape.jpg"],
      "image_size": "16:9"
    }
  }'
```

--------------------------------

### Create Tool Task

Source: https://sjinn.ai/docs/api/tool

Initiates a task to be processed by a specified AI tool. You provide the tool identifier and its specific input parameters.

```APIDOC
## POST /api/un-api/create_tool_task

### Description
Initiates a task to be processed by a specified AI tool. You provide the tool identifier and its specific input parameters.

### Method
POST

### Endpoint
/api/un-api/create_tool_task

### Parameters
#### Request Body
- **tool_type** (string) - Required - Tool identifier from the supported tools list.
- **input** (object) - Required - Tool-specific parameters. All image URLs in `input` must be complete HTTP/HTTPS addresses.

### Request Example
```json
{
  "tool_type": "veo3-text-to-video-fast-api",
  "input": {
    "prompt": "A majestic dragon flying through clouds at sunset",
    "aspect_ratio": "16:9"
  }
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the task creation was successful.
- **errorMsg** (string) - Error message if `success` is false.
- **error_code** (integer) - Error code if `success` is false.
- **data** (object) - Contains task details.
  - **task_id** (string) - The unique identifier for the created task.

#### Response Example
```json
{
  "success": true,
  "errorMsg": "",
  "error_code": 0,
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
```
```

--------------------------------

### Create Agent Task with JavaScript

Source: https://sjinn.ai/docs/api/agent

Starts a new AI Agent task programmatically using JavaScript's fetch API. It sends a POST request with authentication headers and a JSON body containing the task message and optional parameters like template_id and quality. The response includes project and chat IDs.

```javascript
const response = await fetch('https://sjinn.ai/api/un-api/create_agent_task', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Create a video of a cute panda playing with bubbles',
    template_id: '788acc9a-866b-4688-849e-7c7cfffaff54',
    quality: 'quality',
  }),
});

const result = await response.json();
console.log(result);
```

--------------------------------

### SJinn AI Error Response Example (JSON)

Source: https://sjinn.ai/docs/api/agent

This JSON object illustrates a typical error response from the SJinn AI API. It includes a `success` flag set to false, an `errorMsg` describing the issue, and an `error_code` for programmatic handling of specific errors.

```json
{
  "success": false,
  "errorMsg": "Insufficient balance",
  "error_code": 100
}
```
Tokens:
Raw