Mootion API

https://www.mootion.com/api/doc.html
Admin
Mootion API is a text-to-video generation service that creates videos from text prompts with...
Tokens:1,795
Snippets:5
Trust Score:9.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/text2video/{id}

Source: https://www.mootion.com/api/doc.html/index_tag/text-to-video/POST/api/v1/text2video

Retrieves the result of a video generation task by its unique ID. Includes task status and the video URL if generation is complete.

```APIDOC
## GET /api/v1/text2video/{id}

### Description
Get the result of a video generation task by its ID.

### Method
GET

### Endpoint
/api/v1/text2video/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier (UUID) of the video generation task.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://api.seedv.cn/api/v1/text2video/123e4567-e89b-12d3-a456-426614174000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **message** (string) - Response message.
- **data** (object) - Contains task details.
  - **id** (string) - The unique identifier for the generated task.
  - **create_time** (string) - The timestamp when the task was created.
  - **status** (string) - The current status of the task (e.g., "created").
  - **type** (string) - The type of the task.
  - **progress** (object) - Progress of the task.
    - **current** (integer) - Current progress step.
    - **total** (integer) - Total progress steps.
  - **failure_reason** (object) - Reason for task failure, if any.
  - **estimated_remaining_time** (integer) - Estimated time remaining for task completion.
  - **elapsed_total_time** (integer) - Total time elapsed for the task.
  - **video_url** (string) - URL of the generated video (if available).

#### Response Example (200)
```json
{
  "code": 1,
  "message": "string",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "create_time": "2025-12-10T13:22:29.862Z",
    "status": "created",
    "type": "string",
    "progress": {
      "current": 1,
      "total": 1
    },
    "failure_reason": {},
    "estimated_remaining_time": 1,
    "elapsed_total_time": 1,
    "video_url": "string"
  }
}
```

#### Error Response (422)
- **code** (integer) - Response code.
- **message** (string) - Error message.

```

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

### Get Text to Video Task Result (Shell Curl)

Source: https://www.mootion.com/api/doc.html/index_tag/text-to-video/POST/api/v1/text2video

This snippet shows how to retrieve the status and details of a previously created video generation task using its unique ID. The request is made via Shell Curl and requires an authorization token. The response includes task progress, status, and the final video URL if available.

```Shell
curl https://api.seedv.cn/api/v1/text2video/123e4567-e89b-12d3-a456-426614174000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

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

### POST /api/v1/text2video

Source: https://www.mootion.com/api/doc.html/index_tag/text-to-video/POST/api/v1/text2video

Creates an asynchronous task for video generation in the background. Accepts storyboard and composition details to generate video content.

```APIDOC
## POST /api/v1/text2video

### Description
Create an asynchronous task for video generation in the background.

### Method
POST

### Endpoint
/api/v1/text2video

### Parameters
#### Query Parameters
None

#### Request Body
- **storyboard** (StoryboardForm) - Required - Details for the video storyboard.
- **composition** (CompositionForm) - Required - Details for video composition.
- **size** (string) - Optional - The desired resolution for the video. Must be one of: "1920x1080", "1080x1920", "1080x1080". Defaults to "1920x1080".

### Request Example
```json
{
  "size": "1920x1080",
  "storyboard": {
    "style": "photorealistic",
    "user_input": {
      "prompt": "",
      "language": "en-US"
    }
  },
  "composition": {
    "video_config": {
      "title": "Title_EN_Stroke_01",
      "subtitle": "Subtitle_EN_Fill_01"
    },
    "voice_config": "Ava"
  }
}
```

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **message** (string) - Response message.
- **data** (object) - Contains task details.
  - **id** (string) - The unique identifier for the generated task.
  - **create_time** (string) - The timestamp when the task was created.
  - **status** (string) - The current status of the task (e.g., "created").
  - **type** (string) - The type of the task.
  - **progress** (object) - Progress of the task.
    - **current** (integer) - Current progress step.
    - **total** (integer) - Total progress steps.
  - **failure_reason** (object) - Reason for task failure, if any.
  - **estimated_remaining_time** (integer) - Estimated time remaining for task completion.
  - **elapsed_total_time** (integer) - Total time elapsed for the task.
  - **video_url** (string) - URL of the generated video (if available).

#### Response Example (200)
```json
{
  "code": 1,
  "message": "string",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "create_time": "2025-12-10T13:22:29.862Z",
    "status": "created",
    "type": "string",
    "progress": {
      "current": 1,
      "total": 1
    },
    "failure_reason": {},
    "estimated_remaining_time": 1,
    "elapsed_total_time": 1,
    "video_url": "string"
  }
}
```

#### Error Response (422)
- **code** (integer) - Response code.
- **message** (string) - Error message.

```

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

### Create Text to Video Task (Shell Curl)

Source: https://www.mootion.com/api/doc.html/index_tag/text-to-video/POST/api/v1/text2video

This snippet demonstrates how to create an asynchronous video generation task using the Mootion API via a Shell Curl command. It requires a JSON payload specifying storyboard details, composition settings, and desired video size. An authorization token is necessary for authentication.

```Shell
curl https://api.seedv.cn/api/v1/text2video \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "size": "1920x1080",
  "storyboard": {
    "style": "photorealistic",
    "user_input": {
      "prompt": "",
      "language": "en-US"
    }
  },
  "composition": {
    "video_config": {
      "title": "Title_EN_Stroke_01",
      "subtitle": "Subtitle_EN_Fill_01"
    },
    "voice_config": "Ava"
  }
}'
```

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

### Text to Video Task Creation Response Schema

Source: https://www.mootion.com/api/doc.html/index_tag/text-to-video/POST/api/v1/text2video

This JSON schema defines the structure of the response when creating a text-to-video task. It includes a status code, a message, and a data object containing the task ID, creation time, status, progress, and other relevant details for tracking the video generation process.

```JSON
{
  "code": 1,
  "message": "string",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "create_time": "2025-12-10T13:22:29.862Z",
    "status": "created",
    "type": "string",
    "progress": {
      "current": 1,
      "total": 1
    },
    "failure_reason": {},
    "estimated_remaining_time": 1,
    "elapsed_total_time": 1,
    "video_url": "string"
  }
}
```
Tokens:
Raw