257 lines
8.3 KiB
Markdown
257 lines
8.3 KiB
Markdown
# \MidjourneyApi
|
||
|
||
所有 URI 都相对于 *http://localhost*
|
||
|
||
方法 | HTTP 请求 | 描述
|
||
------------- | ------------- | -------------
|
||
[**async_gen_image_api_mj_async_generate_image_post**](MidjourneyApi.md#async_gen_image_api_mj_async_generate_image_post) | **POST** /api/mj/async/generate/image | 异步提交生图任务
|
||
[**async_query_status_api_mj_async_query_status_get**](MidjourneyApi.md#async_query_status_api_mj_async_query_status_get) | **GET** /api/mj/async/query/status | 异步查询任务状态
|
||
[**desc_img_by_file_api_mj_sync_file_img_describe_post**](MidjourneyApi.md#desc_img_by_file_api_mj_sync_file_img_describe_post) | **POST** /api/mj/sync/file/img/describe | 通过文件获取生图的提示词
|
||
[**describe_image_api_api_mj_sync_img_describe_post**](MidjourneyApi.md#describe_image_api_api_mj_sync_img_describe_post) | **POST** /api/mj/sync/img/describe | 获取图像描述
|
||
[**generate_image_api_api_mj_generate_image_post**](MidjourneyApi.md#generate_image_api_api_mj_generate_image_post) | **POST** /api/mj/generate-image | 生成图片
|
||
[**generate_image_sync_api_mj_sync_image_post**](MidjourneyApi.md#generate_image_sync_api_mj_sync_image_post) | **POST** /api/mj/sync/image | 同步生成图片接口
|
||
[**health_check_api_mj_health_get**](MidjourneyApi.md#health_check_api_mj_health_get) | **GET** /api/mj/health | 健康检查
|
||
[**prompt_check_api_mj_prompt_check_get**](MidjourneyApi.md#prompt_check_api_mj_prompt_check_get) | **GET** /api/mj/prompt/check | 🔥图片提示词预审
|
||
|
||
|
||
|
||
## async_gen_image_api_mj_async_generate_image_post
|
||
|
||
> serde_json::Value async_gen_image_api_mj_async_generate_image_post(prompt, img_file)
|
||
异步提交生图任务
|
||
|
||
### 参数
|
||
|
||
|
||
名称 | 类型 | 描述 | 必需 | 备注
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**prompt** | **String** | 提示词 | [必需] |
|
||
**img_file** | Option<**std::path::PathBuf**> | 图片文件 | |
|
||
|
||
### 返回类型
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### 授权
|
||
|
||
无需授权
|
||
|
||
### HTTP 请求头
|
||
|
||
- **Content-Type**: multipart/form-data
|
||
- **Accept**: application/json
|
||
|
||
[[返回顶部]](#) [[返回 API 列表]](../README.md#documentation-for-api-endpoints) [[返回模型列表]](../README.md#documentation-for-models) [[返回 README]](../README.md)
|
||
|
||
|
||
## async_query_status_api_mj_async_query_status_get
|
||
|
||
> serde_json::Value async_query_status_api_mj_async_query_status_get(task_id)
|
||
异步查询任务状态
|
||
|
||
### Parameters
|
||
|
||
|
||
Name | Type | Description | Required | Notes
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**task_id** | **String** | | [required] |
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
||
|
||
## desc_img_by_file_api_mj_sync_file_img_describe_post
|
||
|
||
> serde_json::Value desc_img_by_file_api_mj_sync_file_img_describe_post(img_file, max_wait_time, poll_interval)
|
||
通过文件获取生图的提示词
|
||
|
||
### Parameters
|
||
|
||
|
||
Name | Type | Description | Required | Notes
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**img_file** | **std::path::PathBuf** | 上传的图片 | [required] |
|
||
**max_wait_time** | Option<**i32**> | 最大等待时间(秒) | |[default to 120]
|
||
**poll_interval** | Option<**i32**> | 轮询间隔(秒) | |[default to 2]
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: multipart/form-data
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
||
|
||
## describe_image_api_api_mj_sync_img_describe_post
|
||
|
||
> serde_json::Value describe_image_api_api_mj_sync_img_describe_post(image_url, max_wait_time, poll_interval)
|
||
获取图像描述
|
||
|
||
获取图像描述接口
|
||
|
||
### Parameters
|
||
|
||
|
||
Name | Type | Description | Required | Notes
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**image_url** | **String** | 图片URL地址 | [required] |
|
||
**max_wait_time** | Option<**i32**> | 最大等待时间(秒) | |[default to 120]
|
||
**poll_interval** | Option<**i32**> | 轮询间隔(秒) | |[default to 2]
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: application/x-www-form-urlencoded
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
||
|
||
## generate_image_api_api_mj_generate_image_post
|
||
|
||
> serde_json::Value generate_image_api_api_mj_generate_image_post(prompt, img_file, max_wait_time, poll_interval)
|
||
生成图片
|
||
|
||
生成图片接口
|
||
|
||
### Parameters
|
||
|
||
|
||
Name | Type | Description | Required | Notes
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**prompt** | **String** | 图片生成提示词 | [required] |
|
||
**img_file** | Option<**std::path::PathBuf**> | | |
|
||
**max_wait_time** | Option<**i32**> | 最大等待时间(秒) | |[default to 120]
|
||
**poll_interval** | Option<**i32**> | 轮询间隔(秒) | |[default to 2]
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: multipart/form-data
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
||
|
||
## generate_image_sync_api_mj_sync_image_post
|
||
|
||
> serde_json::Value generate_image_sync_api_mj_sync_image_post(prompt, max_wait_time, poll_interval, img_file)
|
||
同步生成图片接口
|
||
|
||
同步生成图片接口 - 提交任务并轮询结果 Args: prompt (str): 图片生成提示词 img_file: 样貌参考 --oref max_wait_time (int): 最大等待时间，默认120秒 poll_interval (int): 轮询间隔，默认2秒 Returns: dict: 包含status, msg, data的响应字典
|
||
|
||
### Parameters
|
||
|
||
|
||
Name | Type | Description | Required | Notes
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**prompt** | **String** | | [required] |
|
||
**max_wait_time** | Option<**i32**> | | |[default to 120]
|
||
**poll_interval** | Option<**i32**> | | |[default to 2]
|
||
**img_file** | Option<**std::path::PathBuf**> | | |
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: multipart/form-data
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
||
|
||
## health_check_api_mj_health_get
|
||
|
||
> serde_json::Value health_check_api_mj_health_get()
|
||
健康检查
|
||
|
||
健康检查接口
|
||
|
||
### Parameters
|
||
|
||
This endpoint does not need any parameter.
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|
||
|
||
## prompt_check_api_mj_prompt_check_get
|
||
|
||
> serde_json::Value prompt_check_api_mj_prompt_check_get(prompt)
|
||
🔥图片提示词预审
|
||
|
||
### Parameters
|
||
|
||
|
||
Name | Type | Description | Required | Notes
|
||
------------- | ------------- | ------------- | ------------- | -------------
|
||
**prompt** | **String** | | [required] |
|
||
|
||
### Return type
|
||
|
||
[**serde_json::Value**](serde_json::Value.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||
|