API 文档, 在线创建、编辑和管理 AI 矢量。

API : 在线创建、编辑和管理 AI 矢量。

此 API 易于使用。只需按照以下步骤操作

免费创建账户
点击通过电子邮件收到的链接以确认您的地址。
使用凭据生成令牌

您可以使用任何语言进行此 CURL 调用。 (Python, PHP, Java, JavaScript...) 需要帮助？

curl --location --request POST 'https://mxprocess.com/api/login_check' \
                                        --header 'Content-Type: application/json' \
                                        --data-raw '{"username":"YOUR_LOGIN","password":"YOUR_PASSWORD"}'

如果凭据正确，我们的服务器会在响应中提供令牌：

{"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}

YOUR_TOKEN 的有效期为一小时；可以使用 YOUR_REFRESH_TOKEN 延长有效期。

使用令牌启动流程

操作参数

以 JSON 对象发送 parameters。必填字段标记为必填.

operationType — string.
vectorStoreId — string.
vectorName — string.
vectorDescription — string.
urlList — string.
fileIds — string.
question — string.
instructions — string.
filters — string.
alsoDeleteGlobal — boolean.

curl --location 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'file=@"/FILE_PATH/FILE_NAME"' \
--form 'actionName="ManageVector"' \
--form 'parameters={"operationType":"example","vectorStoreId":"example","vectorName":"example","vectorDescription":"example","urlList":"example","fileIds":"example","question":"example","instructions":"example","filters":"example","alsoDeleteGlobal":false}' \
--form 'async="false"' \
--form 'fileUrl=""' \
--form 'fileContent=""'

如果文件可通过 URL 访问，可以忽略“file=@..”字段，直接在“fileUrl”字段中使用文件 URL。

API 会发送 JSON 响应确认流程已完成。使用以下经过身份验证的 URL 下载生成的文件： actionResultsDownloadURLs.


{
    "actionResultsDownloadURLs": [
        "https://mxprocess.com/api/actions/download-result/1016/a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3/YOUR_TOKEN"
    ],
    "id": 1016,
    "actionParameters": [],
    "dateOfDemand": "2024-02-07T20:51:42+00:00",
    "startTime": "2024-02-07T20:51:46+01:00",
    "endTime": "2024-02-07T20:51:46+01:00",
    "hostedFileIds": [
        {
            "fileId": 1025,
            "parameters": ""
        }
    ],
    "action": {
        "actionName": "ManageVector",
        "slug": "all-in-one-online-platform-to-create-edit-and-manage-ai-vectors",
        "jsonRequestSample": null,
        "jsonResponseSample": null,
        "specificDeveloperRequestDocumentation": null,
        "specificDeveloperResponseDocumentation": null,
        "longDescription": null
    },
    "user": [],
    "accomplished": true,
    "userIsNotifiedByEmail": "off",
    "userIsNotifiedByPostQuery": "off",
    "actionResults": [
        [
            "a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3",
            "https://mxprocessfiles.s3.eu-west-1.amazonaws.com/AudioToGPT/1016/a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3"
        ]
    ],
    "priceInTokensAtTimeOfUse": 15,
    "retryCount": 0,
    "executionPlannedAt": null,
    "trackingUrl": ""
}

这份文档是否不清晰？ (Python, PHP, Java, JavaScript...) 需要帮助？

联系我们此 API 也提供异步模式：开发者 API : ManageVector