Create Tune

POST

Spawn a tune.

Request

This endpoint expects an object.

detailsobjectRequired

Details of the tune.

namestringRequired

The name of the tune.

continue_on_rejectionbooleanOptional

Continue fine-tuning if any asset was rejected.

descriptionstringOptional

Description for the tune.

Response

This endpoint returns an object

created_atdatetime

The time this tune task was created.

descriptionstring

The description of the tune.

detailsobject

Tune details. This field is used to store a specific tune type configurations.

idstring

The ID of the LoRA tune.

namestring

The name of the tune.

output_lora_idslist of strings

The output LoRA IDs, if the task was successful.

statusenum

Allowed values: pendingrunningsucceededcancelledfailed

The status of the associated task.

status_detailsstring

The details of the status, only used when the associated task failed.

tenant_idstring

The tenant who requested the LoRA tune.

tune_typeenum

Allowed values: lora_tunetext_tunetext_to_speech_latent_tunetext_to_speech_rvc_tunetext_to_speech_tortoise_tune

The type of this tune.

updated_atdatetime

The time this tune task was updated.

deleted_atdatetimeOptional

The time this tune task was deleted.

resultobjectOptional

Tune result.

succeeded_atdatetimeOptional

The time the tune task succeeded.

POST

1 curl -X POST https://api.octoai.cloud/v1/tune \
2      -H "Content-Type: application/json" \
3      -d '{
4   "details": {
5     "tune_type": "lora_tune",
6     "base_checkpoint": {
7       "checkpoint_id": "string"
8     },
9     "files": [
10       {
11         "file_id": "string"
12       }
13     ],
14     "steps": 0,
15     "trigger_words": [
16       "string"
17     ]
18   },
19   "name": "string"
20 }'

200Successful

1 {
2   "created_at": "2023-01-01T00:00:00Z",
3   "description": "string",
4   "details": {
5     "tune_type": "lora_tune",
6     "base_checkpoint": {
7       "checkpoint_id": "string",
8       "engine": "text/llama-2-7b",
9       "name": "string"
10     },
11     "files": [
12       {
13         "file_id": "string",
14         "caption": "string"
15       }
16     ],
17     "steps": 0,
18     "trigger_words": [
19       "string"
20     ],
21     "resize_images": true,
22     "seed": 0
23   },
24   "id": "string",
25   "name": "string",
26   "output_lora_ids": [
27     "string"
28   ],
29   "status": "pending",
30   "status_details": "string",
31   "tenant_id": "string",
32   "tune_type": "lora_tune",
33   "updated_at": "2023-01-01T00:00:00Z",
34   "deleted_at": "2023-01-01T00:00:00Z",
35   "result": {
36     "number_of_available_assets": 0,
37     "output_assets": [
38       "string"
39     ],
40     "rejected_assets": [
41       "string"
42     ],
43     "unready_assets": [
44       "string"
45     ]
46   },
47   "succeeded_at": "2023-01-01T00:00:00Z"
48 }

1	curl -X POST https://api.octoai.cloud/v1/tune \
2	-H "Content-Type: application/json" \
3	-d '{
4	"details": {
5	"tune_type": "lora_tune",
6	"base_checkpoint": {
7	"checkpoint_id": "string"
8	},
9	"files": [
10	{
11	"file_id": "string"
12	}
13	],
14	"steps": 0,
15	"trigger_words": [
16	"string"
17	]
18	},
19	"name": "string"
20	}'

1	{
2	"created_at": "2023-01-01T00:00:00Z",
3	"description": "string",
4	"details": {
5	"tune_type": "lora_tune",
6	"base_checkpoint": {
7	"checkpoint_id": "string",
8	"engine": "text/llama-2-7b",
9	"name": "string"
10	},
11	"files": [
12	{
13	"file_id": "string",
14	"caption": "string"
15	}
16	],
17	"steps": 0,
18	"trigger_words": [
19	"string"
20	],
21	"resize_images": true,
22	"seed": 0
23	},
24	"id": "string",
25	"name": "string",
26	"output_lora_ids": [
27	"string"
28	],
29	"status": "pending",
30	"status_details": "string",
31	"tenant_id": "string",
32	"tune_type": "lora_tune",
33	"updated_at": "2023-01-01T00:00:00Z",
34	"deleted_at": "2023-01-01T00:00:00Z",
35	"result": {
36	"number_of_available_assets": 0,
37	"output_assets": [
38	"string"
39	],
40	"rejected_assets": [
41	"string"
42	],
43	"unready_assets": [
44	"string"
45	]
46	},
47	"succeeded_at": "2023-01-01T00:00:00Z"
48	}