{"openapi":"3.2.0","info":{"title":"ItsRose API","description":"ItsRose API provides a versatile suite of tools for enhancing, processing, and managing a variety of media and data.","version":"1.0.0"},"servers":[{"url":"https://itsrose-api.jojapi.net"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Audio"},{"name":"Instagram"},{"name":"Mtxx"},{"name":"Remini"},{"name":"Tiktok"}],"x-agent-commerce":{"catalog_url":"https://itsrose-api.jojapi.net/_jojapi/agent/plans","discovery_url":"https://itsrose-api.jojapi.net/.well-known/x402","directory_url":"https://agents.jojapi.net/apis/itsrose-api","docs":"https://docs.jojapi.com/consumers/agents"},"paths":{"/audio/create_clone_voice":{"post":{"operationId":"post_audio_create_clone_voice","summary":"Create Clone Voice","description":"Create a voice clone","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"voice_id":{"type":"string","description":"The unique identifier for the created voice."},"requires_verification":{"type":"boolean","description":"Whether the voice requires verification"}},"required":["voice_id","requires_verification"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"402":{"description":"Payment required — pay per request with x402/mpp (offer in the PAYMENT-REQUIRED / WWW-Authenticate headers and the JSON body), or send a JoJ API key."},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"x-payment-info":{"protocols":["x402","mpp"],"price":{"mode":"fixed","currency":"USD","amount":"0.05"},"intent":"charge"},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"audio_urls":{"type":"array","items":{"type":"string","format":"uri"},"description":"List of audio url."},"name":{"type":"string","minLength":1,"maxLength":100,"description":"A name to identify this voice.\n\n> [!warning]\n> **Do not** include personally identifiable information (PII),\n> such as your email address, phone number, home address, or full legal name.\n\n> [!note]\n> Any personal information you include will be automatically redacted."},"remove_background_noise":{"description":"Whether to remove background noise from the audio files. Defaults to false.","type":"boolean"},"description":{"description":"A description of the voice.","type":"string","maxLength":500},"labels":{"description":"Labels for the voice. Keys can be language, accent, gender, or age.","nullable":true,"anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string"}]}},"required":["audio_urls","name"]},"example":{}}}}}},"/audio/get_models":{"get":{"operationId":"get_audio_get_models","summary":"Get Models","description":"Get available models","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"models":{"type":"array","items":{"type":"object","properties":{"model_id":{"type":"string"},"name":{"type":"string"},"can_be_finetuned":{"type":"boolean"},"can_do_text_to_speech":{"type":"boolean"},"can_do_voice_conversion":{"type":"boolean"},"can_use_style":{"type":"boolean"},"can_use_speaker_boost":{"type":"boolean"},"serves_pro_voices":{"type":"boolean"},"token_cost_factor":{"type":"number"},"description":{"type":"string"},"requires_alpha_access":{"type":"boolean"},"max_characters_request_free_user":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"max_characters_request_subscribed_user":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"maximum_text_length_per_request":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"languages":{"type":"array","items":{"type":"object","properties":{"language_id":{"type":"string"},"name":{"type":"string"}},"required":["language_id","name"],"additionalProperties":false}},"model_rates":{"type":"object","properties":{"character_cost_multiplier":{"type":"number"},"cost_discount_multiplier":{"type":"number"}},"required":["character_cost_multiplier","cost_discount_multiplier"],"additionalProperties":false},"concurrency_group":{"type":"string"}},"required":["model_id","name","can_be_finetuned","can_do_text_to_speech","can_do_voice_conversion","can_use_style","can_use_speaker_boost","serves_pro_voices","token_cost_factor","description","requires_alpha_access","max_characters_request_free_user","max_characters_request_subscribed_user","maximum_text_length_per_request","languages","model_rates","concurrency_group"],"additionalProperties":false},"description":"List of available models"}},"required":["models"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}}}},"/audio/get_voices":{"get":{"operationId":"get_audio_get_voices","summary":"Get Voices","description":"Get available voices","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"object","properties":{"voice_id":{"type":"string","description":"Unique identifier for the voice."},"name":{"type":"string","description":"Display name of the voice."},"samples":{"nullable":true,"description":"Audio samples associated with this voice.","type":"array","items":{"type":"object","additionalProperties":{}}},"category":{"nullable":true,"description":"Category of the voice.","type":"string","enum":["generated","cloned","premade","professional"]},"fine_tuning":{"nullable":true,"description":"Fine-tuning status and configuration for this voice.","type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value labels attached to the voice."},"description":{"nullable":true,"description":"Human-readable description of the voice.","type":"string"},"preview_url":{"nullable":true,"description":"URL to a short audio preview of the voice.","type":"string"},"available_for_tiers":{"type":"array","items":{"type":"string"},"description":"Subscription tiers that have access to this voice."},"settings":{"nullable":true,"description":"Default generation settings for this voice.","type":"object","additionalProperties":{}},"sharing":{"nullable":true,"description":"Sharing configuration if the voice is published to the library.","type":"object","additionalProperties":{}},"high_quality_base_model_ids":{"type":"array","items":{"type":"string"},"description":"Model IDs for which high-quality audio is available."},"verified_languages":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Languages that have been verified for this voice."},"collection_ids":{"type":"array","items":{"type":"string"},"description":"IDs of collections this voice belongs to."},"safety_control":{"nullable":true,"description":"Safety control level applied to this voice.","type":"string","enum":["NONE","BAN","CAPTCHA","CAPTCHA_AND_MODERATION"]},"voice_verification":{"nullable":true,"description":"Verification state and history for this voice.","type":"object","additionalProperties":{}},"permission_on_resource":{"nullable":true,"description":"Permission level the current user has on this voice.","type":"string"},"is_owner":{"nullable":true,"description":"Whether the current user owns this voice.","type":"boolean"},"is_legacy":{"nullable":true,"description":"Whether this is a legacy voice from a prior system.","type":"boolean"},"is_mixed":{"nullable":true,"description":"Whether this voice was created by mixing other voices.","type":"boolean"},"favorited_at_unix":{"nullable":true,"description":"Unix timestamp of when the user favorited this voice.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"created_at_unix":{"nullable":true,"description":"Unix timestamp of when the voice was created.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"is_bookmarked":{"nullable":true,"description":"Whether the current user has bookmarked this voice.","type":"boolean"},"recording_quality":{"nullable":true,"description":"Assessed quality level of the voice recordings.","type":"string","enum":["studio","high","medium","low"]},"labelling_status":{"nullable":true,"description":"Status of the voice labelling process.","type":"string","enum":["in_review","labelled","unlabelled"]},"recording_quality_reason":{"nullable":true,"description":"Explanation for the assigned recording quality level.","type":"string"}},"required":["voice_id","name","samples","category","fine_tuning","labels","description","preview_url","available_for_tiers","settings","sharing","high_quality_base_model_ids","verified_languages","collection_ids","safety_control","voice_verification","permission_on_resource","is_owner","is_legacy","is_mixed","favorited_at_unix","created_at_unix","is_bookmarked","recording_quality","labelling_status","recording_quality_reason"],"additionalProperties":false},"description":"The list of voices matching the query."},"has_more":{"type":"boolean","description":"Whether more voices are available in subsequent pages. Use with next_page_token for reliable pagination."},"total_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total number of voices matching the query. This is a live snapshot and may change between requests; prefer has_more for pagination."},"next_page_token":{"nullable":true,"description":"Token to pass to the next request to retrieve the next page. Null when no more results exist.","type":"string"}},"required":["voices","has_more","total_count","next_page_token"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"parameters":[{"name":"next_page_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["name","created_at_unix"]}},{"name":"sort_direction","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"voice_type","in":"query","required":false,"schema":{"type":"string","enum":["personal","community","default","workspace","non-default","non-community","saved"]}},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["premade","cloned","generated","professional"]}}]}},"/audio/music_compose":{"post":{"operationId":"post_audio_music_compose","summary":"Music compose","description":"Compose a song from a prompt or a composition plan.","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"audio":{"type":"string","description":"Audio url"},"composition_plan":{"anyOf":[{"type":"object","properties":{"positive_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in the entire song."},"negative_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in the entire song."},"sections":{"type":"array","items":{"type":"object","properties":{"section_name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the section."},"positive_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in this section."},"negative_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in this section."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds."},"lines":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":300},"description":"The lyrics of the section. Max 30 lines per section and max 200 characters per line."},"source_from":{"nullable":true,"type":"object","properties":{"negative_ranges":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The ranges to exclude from the 'range'."},"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The time range to extract from the song."}},"required":["negative_ranges","song_id","range"],"additionalProperties":false}},"required":["section_name","positive_local_styles","negative_local_styles","duration_ms","lines"],"additionalProperties":false}}},"required":["positive_global_styles","negative_global_styles","sections"],"additionalProperties":false,"title":"MusicCompostionPrompt","description":"Composition plan for the `music_v1` model. Using this field with any other model will result in an error."},{"type":"object","properties":{"chunks":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","maxLength":6132,"description":"The text config to be generated for this chunk. Can contain an optional section name in square brackets at the beginning, e.g. [Verse 1], lyrics lines, and inline directions in curly braces, e.g. {scratching}.Section names must be between 1 and 100 characters. At most 30 lines are allowed, each at most 200 characters."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds. Must be between `3000ms` and `120000ms`."},"positive_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should be present in this chunk. Use English language for best results. \nThe styles for the first chunk are the most important as they set the overall tone and genre. Styles for subsequent chunks can be used to add nuance, progression, emphasis, or change the direction of the song. Aim to have at least 6-7 styles in early chunks until the direction is established. Generic styles like `great production quality` are good default styles to append to the list."},"negative_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should not be present in this chunk.\nLeaving empty is a good default, only use this field if you want to explicitly avoid a particular style or direction."},"context_adherence":{"description":"How much the model adheres to the context of its surrounding chunks. Low adherence means the model can deviate from the context and be more creative. High adherence means the model will be more consistent with the context.","type":"string","enum":["low","medium","high"]},"conditioning_ref":{"nullable":true,"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The time range to extract from the song."}},"required":["song_id","range"],"additionalProperties":false,"description":"The audio reference to condition the generation on. The first chunk is the most important as it will influence the generation of all subsequent chunks. Thus, if you want to apply conditioning to the entire song, start conditioning from the first chunk."},"condition_strength":{"nullable":true,"type":"string","enum":["low","medium","high","xhigh"],"description":"How strongly the model adheres to the conditioning reference. Low strength means the model will be more creative and deviate from the reference. High strength means the model will be more consistent with the reference."}},"required":["text","duration_ms","positive_styles"],"additionalProperties":false,"title":"MusicCompositionGenerationChunk"},{"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The time range to extract from the song."}},"required":["song_id","range"],"additionalProperties":false,"title":"MusicAudioRef"}]}}},"required":["chunks"],"additionalProperties":false,"title":"MusicCompositionPlan","description":"Composition plan for the `music_v2` and `music_v2_5` models. Using this field with any other model will result in an error."}]},"song_metadata":{"type":"object","properties":{"description":{"nullable":true,"type":"string"},"genres":{"type":"array","items":{"type":"string"}},"is_explicit":{"nullable":true,"type":"boolean"},"languages":{"type":"array","items":{"type":"string"}},"title":{"nullable":true,"type":"string"}},"required":["genres","languages"],"additionalProperties":false,"description":"Song metadata; `null` or empty if `composition_plan` request passed"},"words_timestamps":{},"waveform_visual":{}},"required":["audio","composition_plan","song_metadata"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"402":{"description":"Payment required — pay per request with x402/mpp (offer in the PAYMENT-REQUIRED / WWW-Authenticate headers and the JSON body), or send a JoJ API key."},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"x-payment-info":{"protocols":["x402","mpp"],"price":{"mode":"fixed","currency":"USD","amount":"0.03"},"intent":"charge"},"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"model_id":{"default":"music_v1","type":"string","enum":["music_v1","music_v2","music_v2_5"]},"output_format":{"default":"auto","anyOf":[{"type":"string","enum":["auto"],"description":"Use “auto” (the default) to let the API pick the best format for the selected model","title":"auto"},{"type":"string","enum":["alaw_8000","mp3_22050_32","mp3_24000_48","mp3_44100_128","mp3_44100_192","mp3_44100_32","mp3_44100_64","mp3_44100_96","opus_48000_128","opus_48000_192","opus_48000_32","opus_48000_64","opus_48000_96","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","pcm_8000","ulaw_8000","wav_16000","wav_22050","wav_24000","wav_32000","wav_44100","wav_48000","wav_8000"],"description":"The output format of the generated audio."}]},"sign_with_c2pa":{"description":"Whether to sign the generated song with C2PA. Applicable only for mp3 files.","example":false,"type":"boolean"},"with_timestamps":{"description":"Whether to return the timestamps of the words in the generated song.","default":false,"type":"boolean"},"with_waveform_visual":{"description":"Whether to return the visual waveform of the generated song.","default":false,"type":"boolean"}}},{"anyOf":[{"type":"object","properties":{"prompt":{"type":"string","maxLength":4100,"description":"A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`."},"music_length_ms":{"description":"The length of the song to generate in milliseconds. Used only in conjunction with `prompt`.","nullable":true,"type":"number","minimum":3000,"maximum":120000},"force_instrumental":{"description":"If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the prompt.","example":false,"type":"boolean"}},"required":["prompt"],"title":"Prompt Strategy"},{"type":"object","properties":{"seed":{"description":"Random seed to initialize the music generation process. Cannot be used in conjunction with `prompt`.","nullable":true,"type":"integer","minimum":0,"maximum":2147483647},"composition_plan":{"anyOf":[{"type":"object","properties":{"positive_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in the entire song."},"negative_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in the entire song."},"sections":{"type":"array","items":{"type":"object","properties":{"section_name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the section."},"positive_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in this section."},"negative_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in this section."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds."},"lines":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":300},"description":"The lyrics of the section. Max 30 lines per section and max 200 characters per line."},"source_from":{"nullable":true,"type":"object","properties":{"negative_ranges":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The ranges to exclude from the 'range'."},"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The time range to extract from the song."}},"required":["negative_ranges","song_id","range"]}},"required":["section_name","positive_local_styles","negative_local_styles","duration_ms","lines"]}}},"required":["positive_global_styles","negative_global_styles","sections"],"title":"MusicCompostionPrompt","description":"Composition plan for the `music_v1` model. Using this field with any other model will result in an error."},{"type":"object","properties":{"chunks":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","maxLength":6132,"description":"The text config to be generated for this chunk. Can contain an optional section name in square brackets at the beginning, e.g. [Verse 1], lyrics lines, and inline directions in curly braces, e.g. {scratching}.Section names must be between 1 and 100 characters. At most 30 lines are allowed, each at most 200 characters."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds. Must be between `3000ms` and `120000ms`."},"positive_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should be present in this chunk. Use English language for best results. \nThe styles for the first chunk are the most important as they set the overall tone and genre. Styles for subsequent chunks can be used to add nuance, progression, emphasis, or change the direction of the song. Aim to have at least 6-7 styles in early chunks until the direction is established. Generic styles like `great production quality` are good default styles to append to the list."},"negative_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should not be present in this chunk.\nLeaving empty is a good default, only use this field if you want to explicitly avoid a particular style or direction."},"context_adherence":{"description":"How much the model adheres to the context of its surrounding chunks. Low adherence means the model can deviate from the context and be more creative. High adherence means the model will be more consistent with the context.","type":"string","enum":["low","medium","high"]},"conditioning_ref":{"nullable":true,"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The time range to extract from the song."}},"required":["song_id","range"],"description":"The audio reference to condition the generation on. The first chunk is the most important as it will influence the generation of all subsequent chunks. Thus, if you want to apply conditioning to the entire song, start conditioning from the first chunk."},"condition_strength":{"nullable":true,"type":"string","enum":["low","medium","high","xhigh"],"description":"How strongly the model adheres to the conditioning reference. Low strength means the model will be more creative and deviate from the reference. High strength means the model will be more consistent with the reference."}},"required":["text","duration_ms","positive_styles"],"title":"MusicCompositionGenerationChunk"},{"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The time range to extract from the song."}},"required":["song_id","range"],"title":"MusicAudioRef"}]}}},"required":["chunks"],"title":"MusicCompositionPlan","description":"Composition plan for the `music_v2` and `music_v2_5` models. Using this field with any other model will result in an error."}],"description":"A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`."},"respect_sections_durations":{"description":"Controls how strictly section durations in the composition_plan are enforced. Only applies to music_v1. For music_v2 and music_v2_5, section durations are always enforced and this field is ignored.","type":"boolean"}},"required":["composition_plan"],"title":"Composition Plan Strategy"}]}]},"example":{}}}}}},"/audio/music_compose_plan":{"post":{"operationId":"post_audio_music_compose_plan","summary":"Music composition plan","description":"Create a composition plan for music generation.","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"anyOf":[{"type":"object","properties":{"positive_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in the entire song."},"negative_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in the entire song."},"sections":{"type":"array","items":{"type":"object","properties":{"section_name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the section."},"positive_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in this section."},"negative_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in this section."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds."},"lines":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":300},"description":"The lyrics of the section. Max 30 lines per section and max 200 characters per line."},"source_from":{"nullable":true,"type":"object","properties":{"negative_ranges":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The ranges to exclude from the 'range'."},"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The time range to extract from the song."}},"required":["negative_ranges","song_id","range"],"additionalProperties":false}},"required":["section_name","positive_local_styles","negative_local_styles","duration_ms","lines"],"additionalProperties":false}}},"required":["positive_global_styles","negative_global_styles","sections"],"additionalProperties":false,"title":"MusicCompostionPrompt","description":"Composition plan for the `music_v1` model. Using this field with any other model will result in an error."},{"type":"object","properties":{"chunks":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","maxLength":6132,"description":"The text config to be generated for this chunk. Can contain an optional section name in square brackets at the beginning, e.g. [Verse 1], lyrics lines, and inline directions in curly braces, e.g. {scratching}.Section names must be between 1 and 100 characters. At most 30 lines are allowed, each at most 200 characters."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds. Must be between `3000ms` and `120000ms`."},"positive_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should be present in this chunk. Use English language for best results. \nThe styles for the first chunk are the most important as they set the overall tone and genre. Styles for subsequent chunks can be used to add nuance, progression, emphasis, or change the direction of the song. Aim to have at least 6-7 styles in early chunks until the direction is established. Generic styles like `great production quality` are good default styles to append to the list."},"negative_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should not be present in this chunk.\nLeaving empty is a good default, only use this field if you want to explicitly avoid a particular style or direction."},"context_adherence":{"description":"How much the model adheres to the context of its surrounding chunks. Low adherence means the model can deviate from the context and be more creative. High adherence means the model will be more consistent with the context.","type":"string","enum":["low","medium","high"]},"conditioning_ref":{"nullable":true,"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The time range to extract from the song."}},"required":["song_id","range"],"additionalProperties":false,"description":"The audio reference to condition the generation on. The first chunk is the most important as it will influence the generation of all subsequent chunks. Thus, if you want to apply conditioning to the entire song, start conditioning from the first chunk."},"condition_strength":{"nullable":true,"type":"string","enum":["low","medium","high","xhigh"],"description":"How strongly the model adheres to the conditioning reference. Low strength means the model will be more creative and deviate from the reference. High strength means the model will be more consistent with the reference."}},"required":["text","duration_ms","positive_styles"],"additionalProperties":false,"title":"MusicCompositionGenerationChunk"},{"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"additionalProperties":false,"description":"The time range to extract from the song."}},"required":["song_id","range"],"additionalProperties":false,"title":"MusicAudioRef"}]}}},"required":["chunks"],"additionalProperties":false,"title":"MusicCompositionPlan","description":"Composition plan for the `music_v2` and `music_v2_5` models. Using this field with any other model will result in an error."}]},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"prompt":{"type":"string","description":"A simple text prompt to compose a plan from."},"music_length_ms":{"nullable":true,"type":"number","minimum":3000,"maximum":120000,"description":"The length of the composition plan to generate in milliseconds. \nOptional - if not provided, the model will choose a length based on the prompt."}},"required":["prompt"]},{"oneOf":[{"type":"object","properties":{"model_id":{"type":"string","enum":["music_v1"]},"source_composition_plan":{"example":null,"nullable":true,"allOf":[{"type":"object","properties":{"positive_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in the entire song."},"negative_global_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in the entire song."},"sections":{"type":"array","items":{"type":"object","properties":{"section_name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the section."},"positive_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should be present** in this section."},"negative_local_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that **should not be present** in this section."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds."},"lines":{"maxItems":30,"type":"array","items":{"type":"string","maxLength":300},"description":"The lyrics of the section. Max 30 lines per section and max 200 characters per line."},"source_from":{"nullable":true,"type":"object","properties":{"negative_ranges":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The ranges to exclude from the 'range'."},"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The time range to extract from the song."}},"required":["negative_ranges","song_id","range"]}},"required":["section_name","positive_local_styles","negative_local_styles","duration_ms","lines"]}}},"required":["positive_global_styles","negative_global_styles","sections"],"title":"MusicCompostionPrompt","description":"Composition plan for the `music_v1` model. Using this field with any other model will result in an error."}]}},"required":["model_id"],"title":"MusicCompositionPrompt"},{"type":"object","properties":{"model_id":{"type":"string","enum":["music_v2","music_v2_5"]},"source_composition_plan":{"example":null,"nullable":true,"allOf":[{"type":"object","properties":{"chunks":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","maxLength":6132,"description":"The text config to be generated for this chunk. Can contain an optional section name in square brackets at the beginning, e.g. [Verse 1], lyrics lines, and inline directions in curly braces, e.g. {scratching}.Section names must be between 1 and 100 characters. At most 30 lines are allowed, each at most 200 characters."},"duration_ms":{"type":"number","minimum":3000,"maximum":120000,"description":"The duration of the chunk in milliseconds. Must be between `3000ms` and `120000ms`."},"positive_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should be present in this chunk. Use English language for best results. \nThe styles for the first chunk are the most important as they set the overall tone and genre. Styles for subsequent chunks can be used to add nuance, progression, emphasis, or change the direction of the song. Aim to have at least 6-7 styles in early chunks until the direction is established. Generic styles like `great production quality` are good default styles to append to the list."},"negative_styles":{"type":"array","items":{"type":"string"},"description":"The styles and musical directions that should not be present in this chunk.\nLeaving empty is a good default, only use this field if you want to explicitly avoid a particular style or direction."},"context_adherence":{"description":"How much the model adheres to the context of its surrounding chunks. Low adherence means the model can deviate from the context and be more creative. High adherence means the model will be more consistent with the context.","type":"string","enum":["low","medium","high"]},"conditioning_ref":{"nullable":true,"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The time range to extract from the song."}},"required":["song_id","range"],"description":"The audio reference to condition the generation on. The first chunk is the most important as it will influence the generation of all subsequent chunks. Thus, if you want to apply conditioning to the entire song, start conditioning from the first chunk."},"condition_strength":{"nullable":true,"type":"string","enum":["low","medium","high","xhigh"],"description":"How strongly the model adheres to the conditioning reference. Low strength means the model will be more creative and deviate from the reference. High strength means the model will be more consistent with the reference."}},"required":["text","duration_ms","positive_styles"],"title":"MusicCompositionGenerationChunk"},{"type":"object","properties":{"song_id":{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the song to source the chunk from."},"range":{"type":"object","properties":{"start_ms":{"type":"number"},"end_ms":{"type":"number"}},"required":["start_ms","end_ms"],"description":"The time range to extract from the song."}},"required":["song_id","range"],"title":"MusicAudioRef"}]}}},"required":["chunks"],"title":"MusicCompositionPlan","description":"Composition plan for the `music_v2` and `music_v2_5` models. Using this field with any other model will result in an error."}]}},"required":["model_id"],"title":"MusicCompositionPlan"}],"type":"object"}]},"example":{}}}}}},"/audio/speech_to_speech":{"post":{"operationId":"post_audio_speech_to_speech","summary":"Speech to Speech","description":"Convert speech to speech","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"audio_base64":{"type":"string","description":"Base64-encoded audio data"}},"required":["audio_base64"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"audio":{"anyOf":[{"type":"string","format":"uri","description":"Absolute URL to the audio file if not uploading directly"},{"description":"File as a binary buffer. Only used for multipart/form-data.","type":"string","contentEncoding":"binary","format":"binary"}]}},"required":["audio"]},{"type":"object","properties":{"voice_id":{"type":"string","description":"ID of the voice to be used. Use the [`GET` Voices](#tag/elevenlabs/GET/elevenlabs/get_voices) voices endpoint list all the available voices."},"output_format":{"allOf":[{"type":"string","enum":["alaw_8000","mp3_22050_32","mp3_24000_48","mp3_44100_128","mp3_44100_192","mp3_44100_32","mp3_44100_64","mp3_44100_96","opus_48000_128","opus_48000_192","opus_48000_32","opus_48000_64","opus_48000_96","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","pcm_8000","ulaw_8000","wav_16000","wav_22050","wav_24000","wav_32000","wav_44100","wav_48000","wav_8000"],"description":"The output format of the generated audio."}]},"seed":{"description":"If specified, the system attempts to sample deterministically. Determinism is not guaranteed. Must be integer between `0` and `4294967295`.","nullable":true,"type":"integer","minimum":0,"maximum":2147483647},"model_id":{"type":"string","description":"Identifier of the model that will be used. Use the [`GET` Models](#tag/elevenlabs/GET/elevenlabs/get_models) to list all the available models. And see:\n - **`can_do_text_to_speech`** for `text_to_speech`/`text_to_dialogue`\n - **`can_do_voice_conversion`** for `speech_to_speech`"},"voice_settings":{"allOf":[{"type":"object","properties":{"stability":{"description":"Determines how stable the voice is and the randomness between each generation.","nullable":true,"type":"number","minimum":0,"maximum":1},"use_speaker_boost":{"description":"Whether to boost the speaker's voice. This can make the voice sound louder and more prominent in the audio.","nullable":true,"type":"boolean"},"similarity_boost":{"description":"Determines how closely the AI should adhere to the original voice when attempting to replicate it.","nullable":true,"type":"number","minimum":0,"maximum":1},"style":{"description":"Determines the style exaggeration of the voice.This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.","nullable":true,"type":"number"},"speed":{"description":"Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.","nullable":true,"type":"number"}},"description":"The voice settings for the generated audio."}]},"remove_background_noise":{"description":"Whether to remove background noise from the input audio. This can help improve the quality of the output audio, especially if the input audio is noisy.","type":"boolean"},"file_format":{"description":"The format of input audio. For `pcm_s16le_16`, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order. ","type":"string","enum":["pcm_s16le_16","other"]}},"required":["voice_id"]}]},"example":{}}}}}},"/audio/text_to_dialogue":{"post":{"operationId":"post_audio_text_to_dialogue","summary":"Text to Dialogue","description":"Convert text to dialogue.","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"audio_base64":{"type":"string","description":"Base64-encoded audio data"}},"required":["audio_base64"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"402":{"description":"Payment required — pay per request with x402/mpp (offer in the PAYMENT-REQUIRED / WWW-Authenticate headers and the JSON body), or send a JoJ API key."},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"x-payment-info":{"protocols":["x402","mpp"],"price":{"mode":"fixed","currency":"USD","amount":"0.01"},"intent":"charge"},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"output_format":{"description":"The audio format of the output.","allOf":[{"type":"string","enum":["alaw_8000","mp3_22050_32","mp3_24000_48","mp3_44100_128","mp3_44100_192","mp3_44100_32","mp3_44100_64","mp3_44100_96","opus_48000_128","opus_48000_192","opus_48000_32","opus_48000_64","opus_48000_96","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","pcm_8000","ulaw_8000","wav_16000","wav_22050","wav_24000","wav_32000","wav_44100","wav_48000","wav_8000"],"description":"The output format of the generated audio."}]},"inputs":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"voice_id":{"type":"string","description":"ID of the voice to be used. Use the [`GET` Voices](#tag/elevenlabs/GET/elevenlabs/get_voices) voices endpoint list all the available voices."}},"required":["text","voice_id"],"description":"A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. See [here](https://elevenlabs.io/docs/api-reference/text-to-dialogue/convert#request.body.inputs) for more details."}},"model_id":{"type":"string","description":"Identifier of the model that will be used. Use the [`GET` Models](#tag/elevenlabs/GET/elevenlabs/get_models) to list all the available models. And see:\n - **`can_do_text_to_speech`** for `text_to_speech`/`text_to_dialogue`\n - **`can_do_voice_conversion`** for `speech_to_speech`"},"settings":{"description":"The voice settings to use for the conversion.","nullable":true,"type":"object","properties":{"stability":{"description":"Determines how stable the voice is and the randomness between each generation.","nullable":true,"type":"number","minimum":0,"maximum":1}}},"language_code":{"description":"Language code (ISO 639-1) used to enforce a language for the model and text normalization.","nullable":true,"type":"string"},"apply_text_normalization":{"description":"Whether to apply text normalization to the input text.","type":"string","enum":["auto","on","off"]},"seed":{"description":"If specified, the system attempts to sample deterministically. Determinism is not guaranteed. Must be integer between `0` and `4294967295`.","nullable":true,"type":"integer","minimum":0,"maximum":2147483647}},"required":["inputs"]},"example":{}}}}}},"/audio/text_to_speech":{"post":{"operationId":"post_audio_text_to_speech","summary":"Text to Speech","description":"Convert text to speech","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"audio_base64":{"type":"string","description":"Base64-encoded audio data"}},"required":["audio_base64"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"402":{"description":"Payment required — pay per request with x402/mpp (offer in the PAYMENT-REQUIRED / WWW-Authenticate headers and the JSON body), or send a JoJ API key."},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"x-payment-info":{"protocols":["x402","mpp"],"price":{"mode":"fixed","currency":"USD","amount":"0.01"},"intent":"charge"},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"The text that will get converted into speech."},"voice_id":{"type":"string","description":"ID of the voice to be used. Use the [`GET` Voices](#tag/elevenlabs/GET/elevenlabs/get_voices) voices endpoint list all the available voices."},"model_id":{"type":"string","description":"Identifier of the model that will be used. Use the [`GET` Models](#tag/elevenlabs/GET/elevenlabs/get_models) to list all the available models. And see:\n - **`can_do_text_to_speech`** for `text_to_speech`/`text_to_dialogue`\n - **`can_do_voice_conversion`** for `speech_to_speech`"},"output_format":{"description":"The audio format of the output.","allOf":[{"type":"string","enum":["alaw_8000","mp3_22050_32","mp3_24000_48","mp3_44100_128","mp3_44100_192","mp3_44100_32","mp3_44100_64","mp3_44100_96","opus_48000_128","opus_48000_192","opus_48000_32","opus_48000_64","opus_48000_96","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","pcm_8000","ulaw_8000","wav_16000","wav_22050","wav_24000","wav_32000","wav_44100","wav_48000","wav_8000"],"description":"The output format of the generated audio."}]},"language_code":{"description":"The language code of the text. If not specified, the system will attempt to auto-detect the language.","nullable":true,"type":"string"},"voice_settings":{"description":"The voice settings to use for the conversion.","nullable":true,"allOf":[{"type":"object","properties":{"stability":{"description":"Determines how stable the voice is and the randomness between each generation.","nullable":true,"type":"number","minimum":0,"maximum":1},"use_speaker_boost":{"description":"Whether to boost the speaker's voice. This can make the voice sound louder and more prominent in the audio.","nullable":true,"type":"boolean"},"similarity_boost":{"description":"Determines how closely the AI should adhere to the original voice when attempting to replicate it.","nullable":true,"type":"number","minimum":0,"maximum":1},"style":{"description":"Determines the style exaggeration of the voice.This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.","nullable":true,"type":"number"},"speed":{"description":"Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.","nullable":true,"type":"number"}},"description":"The voice settings for the generated audio."}]},"seed":{"description":"If specified, the system attempts to sample deterministically. Determinism is not guaranteed. Must be integer between `0` and `4294967295`.","nullable":true,"type":"integer","minimum":0,"maximum":2147483647},"previous_text":{"description":"The text that came before the text of the current request.","nullable":true,"type":"string"},"next_text":{"description":"The text that comes after the text of the current request.","nullable":true,"type":"string"},"apply_text_normalization":{"description":"Whether to apply text normalization to the input text.","type":"string","enum":["auto","on","off"]},"apply_language_text_normalization":{"description":"This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. Currently only supported for `Japanese`.","type":"boolean"}},"required":["text","voice_id"]},"example":{}}}}}},"/audio/text_to_speech/with_timestamp":{"post":{"operationId":"post_audio_text_to_speech_with_timestamp","summary":"Text to Speech with timing","description":"Generate speech from text with precise character-level timing information for audio-text synchronization.","tags":["Audio"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"alignment":{"type":"object","properties":{"characters":{"type":"array","items":{"type":"string"},"description":"List of strings"},"character_start_times_seconds":{"type":"array","items":{"type":"number"},"description":"List of doubles"},"character_end_times_seconds":{"type":"array","items":{"type":"number"},"description":"List of doubles"}},"required":["characters","character_start_times_seconds","character_end_times_seconds"],"additionalProperties":false,"description":"Character-level timing information."},"normalized_alignment":{"type":"object","properties":{"characters":{"type":"array","items":{"type":"string"},"description":"List of strings"},"character_start_times_seconds":{"type":"array","items":{"type":"number"},"description":"List of doubles"},"character_end_times_seconds":{"type":"array","items":{"type":"number"},"description":"List of doubles"}},"required":["characters","character_start_times_seconds","character_end_times_seconds"],"additionalProperties":false,"description":"Character-level timing information."},"audio_base64":{"type":"string","description":"Base64-encoded audio data"}},"required":["alignment","normalized_alignment","audio_base64"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"The text that will get converted into speech."},"voice_id":{"type":"string","description":"ID of the voice to be used. Use the [`GET` Voices](#tag/elevenlabs/GET/elevenlabs/get_voices) voices endpoint list all the available voices."},"model_id":{"type":"string","description":"Identifier of the model that will be used. Use the [`GET` Models](#tag/elevenlabs/GET/elevenlabs/get_models) to list all the available models. And see:\n - **`can_do_text_to_speech`** for `text_to_speech`/`text_to_dialogue`\n - **`can_do_voice_conversion`** for `speech_to_speech`"},"output_format":{"description":"The audio format of the output.","allOf":[{"type":"string","enum":["alaw_8000","mp3_22050_32","mp3_24000_48","mp3_44100_128","mp3_44100_192","mp3_44100_32","mp3_44100_64","mp3_44100_96","opus_48000_128","opus_48000_192","opus_48000_32","opus_48000_64","opus_48000_96","pcm_16000","pcm_22050","pcm_24000","pcm_32000","pcm_44100","pcm_48000","pcm_8000","ulaw_8000","wav_16000","wav_22050","wav_24000","wav_32000","wav_44100","wav_48000","wav_8000"],"description":"The output format of the generated audio."}]},"language_code":{"description":"The language code of the text. If not specified, the system will attempt to auto-detect the language.","nullable":true,"type":"string"},"voice_settings":{"description":"The voice settings to use for the conversion.","nullable":true,"allOf":[{"type":"object","properties":{"stability":{"description":"Determines how stable the voice is and the randomness between each generation.","nullable":true,"type":"number","minimum":0,"maximum":1},"use_speaker_boost":{"description":"Whether to boost the speaker's voice. This can make the voice sound louder and more prominent in the audio.","nullable":true,"type":"boolean"},"similarity_boost":{"description":"Determines how closely the AI should adhere to the original voice when attempting to replicate it.","nullable":true,"type":"number","minimum":0,"maximum":1},"style":{"description":"Determines the style exaggeration of the voice.This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.","nullable":true,"type":"number"},"speed":{"description":"Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.","nullable":true,"type":"number"}},"description":"The voice settings for the generated audio."}]},"seed":{"description":"If specified, the system attempts to sample deterministically. Determinism is not guaranteed. Must be integer between `0` and `4294967295`.","nullable":true,"type":"integer","minimum":0,"maximum":2147483647},"previous_text":{"description":"The text that came before the text of the current request.","nullable":true,"type":"string"},"next_text":{"description":"The text that comes after the text of the current request.","nullable":true,"type":"string"},"apply_text_normalization":{"description":"Whether to apply text normalization to the input text.","type":"string","enum":["auto","on","off"]},"apply_language_text_normalization":{"description":"This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. Currently only supported for `Japanese`.","type":"boolean"}},"required":["text","voice_id"]},"example":{}}}}}},"/instagram/get_media":{"get":{"operationId":"get_instagram_get_media","summary":"Get Instagram Media","description":"Get Instagram media details","tags":["Instagram"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"media_list":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The direct URL to the media file."},"is_video":{"type":"boolean","description":"Indicates whether the media is a video."}},"required":["url","is_video"],"additionalProperties":false},"description":"List of media items."}},"required":["media_list"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"parameters":[{"name":"url","in":"query","description":"Instagram post/reel url.","required":true,"schema":{"type":"string"}}]}},"/mtxx/clothes_segmentation":{"post":{"operationId":"post_mtxx_clothes_segmentation","summary":"Clothes Segmentation","description":"Generate a mask for the clothes in the image.","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"segmentation_mask":{"type":"array","items":{"type":"string","format":"uri"},"description":"Array of segmentation mask URLs"},"labels":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","enum":["background","headpiece","hair","gloves","glasses","top","dress","coat","socks","pants","skin","scarf etc.","skirt","face","shoes","bag","accessories","jumpsuit","mannequin_stand"],"description":"Possible labels for segmented clothing items"},"n_label":{"type":"string","description":"Numeric label for the segmented clothing item"},"url":{"type":"string","format":"uri","description":"URL of the segmented clothing item"}},"required":["label","n_label","url"],"additionalProperties":false},"description":"Array of segmented clothing items"}},"required":["segmentation_mask","labels"],"additionalProperties":{}},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]},"example":{}}}}}},"/mtxx/expression_generation":{"post":{"operationId":"post_mtxx_expression_generation","summary":"Expression Generation","description":"This interface is used to process requests generated for smile expressions in the cloud.","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","in_progress","completed","failed"],"description":"Task status"},"task_id":{"type":"string","description":"Task Unique Identifier"},"media_list":{"type":"array","items":{"type":"string"},"description":"Output media list"}},"required":["status","task_id","media_list"],"additionalProperties":{},"description":"The response schema for MTXx API."},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"smile_mode":{"type":"integer","minimum":0,"maximum":5,"description":"Smile mode:\n\n- 0: Laughing\n- 1: Smile\n- 2: Pursed lips smile\n- 3: Cool\n- 4: Classic smile with dimples\n- 5: Dimples secondary effect"},"mtxx_mz_kl_flag":{"description":"Lips cooler interface flag (0: Default, 1: Enabled)","type":"integer","minimum":0,"maximum":1},"wb_flag":{"description":"White balance post-processing flag (0: Disabled, 1: Enabled)","type":"integer","minimum":0,"maximum":1}},"required":["smile_mode"]},{"type":"object","properties":{"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]}],"title":"Expression Generation Request Schema"},"example":{}}}}}},"/mtxx/get_task":{"get":{"operationId":"get_mtxx_get_task","summary":"Get task","description":"Query sync task","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","in_progress","completed","failed"],"description":"Task status"},"task_id":{"type":"string","description":"Task Unique Identifier"},"media_list":{"type":"array","items":{"type":"string"},"description":"Output media list"}},"required":["status","task_id","media_list"],"additionalProperties":{},"description":"The response schema for MTXx API."},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"parameters":[{"name":"task_id","in":"query","description":"Task id.","required":true,"schema":{"type":"string"}}]}},"/mtxx/image_restoration":{"post":{"operationId":"post_mtxx_image_restoration","summary":"Image Restoration","description":"Image Quality Restoration.","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","in_progress","completed","failed"],"description":"Task status"},"task_id":{"type":"string","description":"Task Unique Identifier"},"media_list":{"type":"array","items":{"type":"string"},"description":"Output media list"}},"required":["status","task_id","media_list"],"additionalProperties":{},"description":"The response schema for MTXx API."},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"ir_mode":{"description":"Effect mode","type":"string","enum":["wink-ultra-hd","xiuxiu-ultra-hd"]},"save_photo_format":{"description":"Output image format","type":"string","enum":["jpg","png"]},"use_denoise":{"description":"Background repair flag.","type":"boolean"},"use_hd_face_opt":{"description":"Portrait Repair Upgrade flag.","type":"boolean"}}},{"type":"object","properties":{"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]}],"title":"Image Restoration Request Schema"},"example":{}}}}}},"/mtxx/outpainting":{"post":{"operationId":"post_mtxx_outpainting","summary":"Outpainting","description":"Extends an image beyond its original canvas using AI outpainting.","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","in_progress","completed","failed"],"description":"Task status"},"task_id":{"type":"string","description":"Task Unique Identifier"},"media_list":{"type":"array","items":{"type":"string"},"description":"Output media list"}},"required":["status","task_id","media_list"],"additionalProperties":{},"description":"The response schema for MTXx API."},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","properties":{"expand_ratio":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.1,"description":"Accepts a value between `0.0` and `1.0` in increments of `0.1`.\n\nThe final canvas size is calculated as: `original_size × (1 + ratio × 2)`.\n\n| Value | Width & Height Scale |\n|-------|----------------------|\n| `0.1` | 120% of original     |\n| `0.3` | 160% of original     |\n| `0.5` | 200% of original     |\n| `1.0` | 300% of original     |"}},"required":["expand_ratio"]},{"type":"object","properties":{"seed":{"description":"Controls the randomness of the generation. Use a fixed value to reproduce the same result across requests. Set to `-1` to use a random seed on each request.","type":"integer","minimum":-1,"maximum":65535},"extra_prompt":{"description":"Supplementary text prompt to guide the outpainting generation. Only English is supported. Separate multiple prompt keywords with a comma (`,`).","type":"string"},"high_quality_encode":{"description":"When `true`, the output image is encoded with high-quality, low-compression settings, producing larger file sizes but preserving finer details and reducing artifacts.","type":"boolean"},"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]}],"title":"Uniform Expand Ratio","description":"Expands the image canvas uniformly on all sides using a single ratio value."},{"allOf":[{"type":"object","properties":{"free_expand_ratio":{"type":"object","properties":{"left":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.1,"description":"Expansion ratio for the left side. Range: `0.0` – `1.0`."},"right":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.1,"description":"Expansion ratio for the right side. Range: `0.0` – `1.0`."},"top":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.1,"description":"Expansion ratio for the top side. Range: `0.0` – `1.0`."},"bottom":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.1,"description":"Expansion ratio for the bottom side. Range: `0.0` – `1.0`."}},"required":["left","right","top","bottom"],"title":"Per-Side Expansion Ratios","description":"Defines independent expansion ratios for each side of the image. \n- `left` and `right` are proportional to the original width. \n- `top` and `bottom` are proportional to the original height."}},"required":["free_expand_ratio"]},{"type":"object","properties":{"seed":{"description":"Controls the randomness of the generation. Use a fixed value to reproduce the same result across requests. Set to `-1` to use a random seed on each request.","type":"integer","minimum":-1,"maximum":65535},"extra_prompt":{"description":"Supplementary text prompt to guide the outpainting generation. Only English is supported. Separate multiple prompt keywords with a comma (`,`).","type":"string"},"high_quality_encode":{"description":"When `true`, the output image is encoded with high-quality, low-compression settings, producing larger file sizes but preserving finer details and reducing artifacts.","type":"boolean"},"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]}],"title":"Free Expand Ratio","description":"Expands the image canvas independently on each side using per-side ratio values. Use this when the subject is off-center or asymmetric padding is required."},{"allOf":[{"type":"object","properties":{"free_expand_pixel":{"type":"object","properties":{"left":{"type":"integer","minimum":0,"maximum":2048,"description":"Pixels to add to the left side. Range: `0` – `2048`."},"right":{"type":"integer","minimum":0,"maximum":2048,"description":"Pixels to add to the right side. Range: `0` – `2048`."},"top":{"type":"integer","minimum":0,"maximum":2048,"description":"Pixels to add to the top side. Range: `0` – `2048`."},"bottom":{"type":"integer","minimum":0,"maximum":2048,"description":"Pixels to add to the bottom side. Range: `0` – `2048`."}},"required":["left","right","top","bottom"],"title":"Per-Side Expansion Pixels","description":"Defines the exact number of pixels to add to each side of the image canvas. Provides pixel-level precision for layouts where exact output dimensions are required."}},"required":["free_expand_pixel"]},{"type":"object","properties":{"seed":{"description":"Controls the randomness of the generation. Use a fixed value to reproduce the same result across requests. Set to `-1` to use a random seed on each request.","type":"integer","minimum":-1,"maximum":65535},"extra_prompt":{"description":"Supplementary text prompt to guide the outpainting generation. Only English is supported. Separate multiple prompt keywords with a comma (`,`).","type":"string"},"high_quality_encode":{"description":"When `true`, the output image is encoded with high-quality, low-compression settings, producing larger file sizes but preserving finer details and reducing artifacts.","type":"boolean"},"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]}],"title":"Free Expand Pixel","description":"Expands the image canvas by an absolute pixel count on each side. Use this when you need precise control over the output image dimensions."}],"title":"Outpainting Request"},"example":{}}}}}},"/mtxx/remove_bg":{"post":{"operationId":"post_mtxx_remove_bg","summary":"Remove BG","description":"Remove background from an image.","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","in_progress","completed","failed"],"description":"Task status"},"task_id":{"type":"string","description":"Task Unique Identifier"},"media_list":{"type":"array","items":{"type":"string"},"description":"Output media list"}},"required":["status","task_id","media_list"],"additionalProperties":{},"description":"The response schema for MTXx API."},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]},"example":{}}}}}},"/mtxx/versatile_hairstyle":{"post":{"operationId":"post_mtxx_versatile_hairstyle","summary":"Versatile Hairstyle","description":"Versatile Hairstyle is a hairstyle that can be adapted to different occasions and styles.","tags":["Mtxx"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","in_progress","completed","failed"],"description":"Task status"},"task_id":{"type":"string","description":"Task Unique Identifier"},"media_list":{"type":"array","items":{"type":"string"},"description":"Output media list"}},"required":["status","task_id","media_list"],"additionalProperties":{},"description":"The response schema for MTXx API."},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"hair_type":{"type":"string","description":"Specifies the target hairstyle to apply. See Example rendered visual for more detail."}},"required":["hair_type"]},{"type":"object","properties":{"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"sync_timeout":{"type":"number","minimum":-1,"maximum":60,"description":"**Synchronized waiting timeout (seconds).**\n\n`-1` means no waiting, the API returns immediately. Default `30`.\n\n> [!tip]\n > It is recommended to use the Task Query","example":30}},"required":["init_image","sync_timeout"]}],"title":"Versatile Hairstyle Request"},"example":{}}}}}},"/remini/create_task":{"post":{"operationId":"post_remini_create_task","summary":"Create Task","description":"Create remini image enhance task","tags":["Remini"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"media_list":{"type":"array","items":{"type":"string","format":"uri"},"description":"The media access url."}},"required":["media_list"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"init_image":{"anyOf":[{"title":"url","type":"string","format":"uri"},{"title":"base64","type":"string","format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"}],"description":"The URL or base64 string of the image to be used as the initial image.","example":"https://assets.itsrose.net/public-resource/girl-in-red-dress.jpg"},"pipelines":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"auto_balance":{"type":"object","properties":{"auto_contrast":{"type":"object","properties":{"contrast_intensity_coefficient":{"type":"number","minimum":0,"maximum":10,"description":"Coefficient controlling contrast intensity for automatic contrast adjustment."}},"required":["contrast_intensity_coefficient"]}},"required":["auto_contrast"],"example":{"auto_contrast":{"contrast_intensity_coefficient":1.5}}},"background_enhance":{"type":"object","properties":{"model":{"type":"string","enum":["shiba-strong-tensorrt","rhino-tensorrt","upsampler-bicubic"],"description":"Identifier of the model used for background enhancement or upsampling."},"remove_color_shift":{"type":"boolean","description":"When true, removes color shifts as part of background enhancement."}},"required":["model","remove_color_shift"],"example":{"model":"shiba-strong-tensorrt","remove_color_shift":true}},"bokeh":{"type":"object","properties":{"aperture_radius":{"type":"number","minimum":0,"maximum":1,"description":"A normalized aperture radius for the bokeh effect. Value must be between 0 and 1."},"apply_front_bokeh":{"type":"boolean","description":"Flag indicating whether the bokeh effect should be applied to foreground elements."},"group_picture":{"type":"boolean","description":"Flag indicating if the image contains multiple subjects (group photo), which may alter face-related processing."},"highlights":{"type":"number","minimum":0,"maximum":1,"description":"Normalized intensity of highlights in the bokeh effect (0 to 1)."},"rescale_kernel_for_small_images":{"type":"boolean","description":"When true, rescales the blur kernel for small images to preserve bokeh quality."},"vivid":{"type":"number","minimum":0,"maximum":1,"description":"Normalized vividness parameter for the bokeh effect (0 to 1)."}},"required":["aperture_radius","apply_front_bokeh","group_picture","highlights","rescale_kernel_for_small_images","vivid"],"example":{"aperture_radius":0.3,"apply_front_bokeh":false,"group_picture":true,"highlights":0.25,"rescale_kernel_for_small_images":true,"vivid":0.75}},"color_enhance":{"type":"object","properties":{"model":{"type":"string","enum":["prism-blend","orange-teal","orange-teal_v2","silky","muted","lit_soft_warm","prism-expert-a","prism-expert-c"],"description":"Identifier of the color enhancement model to apply."}},"required":["model"],"example":{"model":"muted"}},"dodge_burn":{"type":"object","properties":{"model":{"type":"string","enum":["dodge_burn_residuals_big"],"description":"Identifier for the dodge-and-burn residuals model."},"intensity":{"type":"number","minimum":0,"maximum":1,"description":"Intensity of the dodge-and-burn effect, normalized from 0.0 to 1.0."}},"required":["model","intensity"],"example":{"intensity":0.5,"model":"dodge_burn_residuals_big"}},"face_enhance":{"type":"object","properties":{"model":{"type":"string","enum":["remini","recommender_entire_dataset"],"description":"Identifier of the face enhancement model to apply."},"pre_blur":{"type":"number","minimum":0,"maximum":1,"description":"Amount of pre-blur applied prior to face enhancement, normalized between 0 and 1."}},"required":["model","pre_blur"],"example":{"model":"remini","pre_blur":0.6}},"face_lifting":{"type":"object","properties":{"model":{"type":"string","enum":["movie-style","marzipan-style","pinko_bigger_dataset-style"],"description":"Identifier of the face lifting model to be applied."}},"required":["model"],"example":{"model":"movie-style"}}}},"description":"Ordered list of image processing pipelines to execute (min 1, max 5).\n\n> [!warning] Unsuppoer mix of feature will cause an error"}},"required":["init_image","pipelines"]},"example":{}}}}}},"/tiktok/get_content":{"get":{"operationId":"get_tiktok_get_content","summary":"Get Tiktok Content","description":"Get tiktok content details","tags":["Tiktok"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true],"title":"Success indicator","description":"Indicates that the response represents a successful operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the success status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"object","properties":{"aweme_id":{"type":"string"},"id":{"type":"string"},"region":{"type":"string"},"author":{"type":"object","properties":{"id":{"type":"string"},"unique_id":{"type":"string"},"nickname":{"type":"string"},"avatar":{"type":"string"}},"required":["id","unique_id","nickname","avatar"],"additionalProperties":false},"title":{"type":"string"},"media_list":{"type":"object","properties":{"cover":{"type":"object","properties":{"thumbnail":{"type":"string","format":"uri"},"ai_dynamic_cover":{"type":"string","format":"uri"},"origin_cover":{"type":"string","format":"uri"}},"required":["thumbnail","ai_dynamic_cover","origin_cover"],"additionalProperties":false},"watermark":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"size":{"type":"number"}},"required":["url","size"],"additionalProperties":false},"no_watermak":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"size":{"type":"number"}},"required":["url","size"],"additionalProperties":false},"music":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"cover":{"type":"string"},"author":{"type":"string"},"is_original":{"type":"boolean"},"duration":{"type":"number"}},"required":["id","title","url","cover","author","is_original","duration"],"additionalProperties":false},"images":{"default":null,"nullable":true,"type":"array","items":{"type":"string","format":"uri"}}},"required":["cover","watermark","no_watermak","music","images"],"additionalProperties":false},"statistic":{"type":"object","properties":{"play_count":{"type":"number"},"digg_count":{"type":"number"},"comment_count":{"type":"number"},"share_count":{"type":"number"},"download_count":{"type":"number"},"collect_count":{"type":"number"}},"required":["play_count","digg_count","comment_count","share_count","download_count","collect_count"],"additionalProperties":false}},"required":["aweme_id","id","region","author","title","media_list","statistic"],"additionalProperties":false},"errors":{"type":"string","nullable":true,"enum":[null],"title":"No errors on success responses","description":"The errors field is always null for success responses."},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false}}}},"4XX":{"description":"Client Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}},"5XX":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[false],"title":"Failure indicator","description":"Indicates that the response represents a failed operation."},"code":{"type":"number","title":"Response code","description":"The numeric code representing the failure status."},"message":{"type":"string","title":"Response message","description":"A human-readable message providing additional information."},"data":{"type":"string","nullable":true,"enum":[null],"title":"No data on failure responses","description":"The data field is always null for failure responses."},"errors":{"default":{},"title":"Error details","description":"The errors field contains details about the failure. It is optional and may be omitted if no additional error information is provided.","type":"object","additionalProperties":{}},"meta":{"default":{},"title":"Metadata","description":"Additional metadata related to the response. **Do not** rely on this field for any critical information, as it may be omitted or changed without notice.","type":"object","additionalProperties":{}}},"required":["ok","code","message","data","errors","meta"],"additionalProperties":false,"description":"Representing a failed response.","title":"Failure Response Schema"}}}}},"parameters":[{"name":"url","in":"query","description":"TikTok url. Can be copied from share option on the App.","required":true,"schema":{"type":"string"}}]}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-JoJAPI-Key","description":"Your JoJ API key."}}}}