1 of 3

GenAI Factory API

Create Task

This API is used to create a task for various purposes, such as generating audio content based on the specified parameters and input data.

API Endpoint

POST https://api.genaifactory.ai/v1/create_task

Headers

Name

Type

Required

Description

Request Body

Name

Type

Required

Description

Parameters (params)

Name

Type

Required

Description

Input Data (input_data)

Name

Type

Required

Description

Text Object

Name

Type

Required

Description

Example Request

Response

Returns a JSON object containing the task details.

Example Response

Get Task Status

This API retrieves the status and details of a specific task using its unique task_id.

API Endpoint

GET https://api.genaifactory.ai/v1/task/{task_id}

Headers

Name

Type

Required

Description

formalcloud-api-key

string

Yes

API key for authentication

Request Parameters

Name

Type

Required

Description

task_id

integer

Yes

The unique identifier of the task.

Example Request

curl --location 'http://api.genaifactory.ai/v1/task/333' \
--header 'formacloud-api-key:  to replace' \
--data ''

Response

Returns a JSON object containing the status, input, output, and details of the requested task.

Field

Type

Description

created_at

string

The timestamp when the task was created.

finished_at

string

The timestamp when the task was completed.

input_data

array

An array containing the input data for the task.

language_code

string

The language code detected for the input data.

output_data

array

An array containing the output data of the task, if available.

task_id

integer

The unique identifier for the task.

task_status

string

The current status of the task (CREATED, RUNNING, SUCCESS, or FAILED).

task_type

string

The type of task created.

Input Data (input_data)

Field

Type

Description

type

string

The type of the input (e.g., text).

text

object

Contains the input text content.

Output Data (output_data)

Field

Type

Description

type

string

The type of the output (e.g., audio).

url

string

The URL to access the generated output.

length

float

The duration of the output in seconds.

Example Response

{
    "created_at": "Sat, 16 Nov 2024 05:24:47 GMT",
    "finished_at": "Sat, 16 Nov 2024 05:26:03 GMT",
    "input_data": [
        {
            "text": {
                "content": "To resolve this issue, you can run the command as the root user in the Dockerfile. By default, the Docker build process executes commands as root, so this is often a configuration or permissions issue in the Docker environment. Below are several ways to address the issue"
            },
            "type": "text"
        }
    ],
    "language_code": "en",
    "output_data": [
        {
            "length": 17.31918367346939,
            "type": "audio",
            "url": "https://cdn.genaifactory.ai/gen_ai_factory/temp/audio/2024/11/16/0bcc4bc2128142d3b483eddbc1f32a07.mp3"
        }
    ],
    "task_id": 333,
    "task_status": "SUCCESS",
    "task_type": "TTS"
}

Get Task Status

This API retrieves the status and details of a specific task using its unique task_id.

API Endpoint

GET https://api.genaifactory.ai/v1/task/{task_id}

Headers

Name

Type

Required

Description

formalcloud-api-key

string

Yes

API key for authentication

Request Parameters

Name

Type

Required

Description

task_id

integer

Yes

The unique identifier of the task.

Example Request

curl --location 'http://api.genaifactory.ai/v1/task/333' \
--header 'formacloud-api-key:  to replace' \
--data ''

Response

Returns a JSON object containing the status, input, output, and details of the requested task.

Field

Type

Description

created_at

string

The timestamp when the task was created.

finished_at

string

The timestamp when the task was completed.

input_data

array

An array containing the input data for the task.

language_code

string

The language code detected for the input data.

output_data

array

An array containing the output data of the task, if available.

task_id

integer

The unique identifier for the task.

task_status

string

The current status of the task (CREATED, RUNNING, SUCCESS, or FAILED).

task_type

string

The type of task created.

Input Data (input_data)

Field

Type

Description

type

string

The type of the input (e.g., text).

text

object

Contains the input text content.

Output Data (output_data)

Field

Type

Description

type

string

The type of the output (e.g., audio).

url

string

The URL to access the generated output.

length

float

The duration of the output in seconds.

Example Response

{
    "created_at": "Sat, 16 Nov 2024 05:24:47 GMT",
    "finished_at": "Sat, 16 Nov 2024 05:26:03 GMT",
    "input_data": [
        {
            "text": {
                "content": "To resolve this issue, you can run the command as the root user in the Dockerfile. By default, the Docker build process executes commands as root, so this is often a configuration or permissions issue in the Docker environment. Below are several ways to address the issue"
            },
            "type": "text"
        }
    ],
    "language_code": "en",
    "output_data": [
        {
            "length": 17.31918367346939,
            "type": "audio",
            "url": "https://cdn.genaifactory.ai/gen_ai_factory/temp/audio/2024/11/16/0bcc4bc2128142d3b483eddbc1f32a07.mp3"
        }
    ],
    "task_id": 333,
    "task_status": "SUCCESS",
    "task_type": "TTS"
}

Create Task

This API is used to create a task for various purposes, such as generating audio content based on the specified parameters and input data.

API Endpoint

POST https://api.genaifactory.ai/v1/create_task

Headers

Name

Type

Required

Description

Request Body

Name

Type

Required

Description

Parameters (params)

Name

Type

Required

Description

Input Data (input_data)

Name

Type

Required

Description

Text Object

Name

Type

Required

Description

Example Request

curl --location 'http://api.genaifactory.ai/v1/create_task' \
--header 'formacloud-api-key: to replace' \
--header 'Content-Type: application/json' \
--data '{
    "task_type": "TTS",
    "params": {
        "reporter_voice": "US_MALE_01"
    },
    "input_data": [
        {
            "type": "text",
            "text": {
                "content": "To resolve this issue, you can run the command as the root user in the Dockerfile. By default, the Docker build process executes commands as root, so this is often a configuration or permissions issue in the Docker environment. Below are several ways to address the issue"
            }
        }
    ]
}'

Response

Returns a JSON object containing the task details.

Field

Type

Description

Example Response

{
    "created_at": "Sat, 16 Nov 2024 05:24:47 GMT",
    "task_id": 333,
    "task_status": "CREATED",
    "task_type": "TTS"
}

The reporter's voice model:

AMERICAN_MALE_1
AMERICAN_MALE_2
AMERICAN_MALE_3
AMERICAN_FEMALE_1
AMERICAN_FEMALE_2
AMERICAN_FEMALE_3
BRITISH_MALE_1
BRITISH_MALE_2
BRITISH_MALE_3
BRITISH_FEMALE_1
BRITISH_FEMALE_2
BRITISH_FEMALE_3
AUSTRALIAN_MALE_1
AUSTRALIAN_MALE_2
AUSTRALIAN_MALE_3
AUSTRALIAN_FEMALE_1
AUSTRALIAN_FEMALE_2
AUSTRALIAN_FEMALE_3
CANADIAN_MALE_1
CANADIAN_MALE_2
CANADIAN_MALE_3
CANADIAN_FEMALE_1
CANADIAN_FEMALE_2
CANADIAN_FEMALE_3