mirror of
https://github.com/langgenius/dify.git
synced 2026-11-11 05:41:09 +08:00
96b1b20c76
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Stephen Zhou <hi@hyoban.cc>
38548 lines
1.5 MiB
Plaintext
Generated
38548 lines
1.5 MiB
Plaintext
Generated
# Console API
|
|
Console management APIs for app configuration, monitoring, and administration
|
|
|
|
## Version: 1.0
|
|
|
|
### Available authorizations
|
|
#### Bearer (HTTP, bearer)
|
|
Use the Service API key as a Bearer token in the Authorization header.
|
|
Bearer format: API_KEY
|
|
|
|
---
|
|
## console
|
|
Console management API operations
|
|
|
|
### [GET] /account/avatar
|
|
Get account avatar url
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| avatar | query | Avatar file ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AvatarUrlResponse](#avatarurlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/change-email
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChangeEmailSendPayload](#changeemailsendpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailChangeRateLimitExceededError](#emailchangeratelimitexceedederror)<br>[EmailSendIpLimitError](#emailsendiplimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/change-email/check-email-unique
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CheckEmailUniquePayload](#checkemailuniquepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountInFreezeError](#accountinfreezeerror)<br>[EmailAlreadyInUseError](#emailalreadyinuseerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/change-email/reset
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChangeEmailResetPayload](#changeemailresetpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountResponse](#accountresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountInFreezeError](#accountinfreezeerror)<br>[AccountNotFoundError](#accountnotfounderror)<br>[EmailAlreadyInUseError](#emailalreadyinuseerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/change-email/validity
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChangeEmailValidityPayload](#changeemailvaliditypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [VerificationTokenResponse](#verificationtokenresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [EmailCodeError](#emailcodeerror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailChangeLimitError](#emailchangelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/delete
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AccountDeletePayload](#accountdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidAccountDeletionCodeError](#invalidaccountdeletioncodeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/delete/feedback
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AccountDeletionFeedbackPayload](#accountdeletionfeedbackpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /account/delete/verify
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailCodeAccountDeletionRateLimitExceededError](#emailcodeaccountdeletionratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /account/education
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EducationStatusResponse](#educationstatusresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [BillingRequestInProgressError](#billingrequestinprogresserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/education
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EducationActivatePayload](#educationactivatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EducationActivateResponse](#educationactivateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[EducationActivateFailedError](#educationactivatefailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [BillingRequestInProgressError](#billingrequestinprogresserror)<br>[EducationActivateLimitError](#educationactivatelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /account/education/autocomplete
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keywords | query | | Yes | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EducationAutocompleteResponse](#educationautocompleteresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /account/education/verify
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EducationVerifyResponse](#educationverifyresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[EducationVerifyFailedError](#educationverifyfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [BillingRequestInProgressError](#billingrequestinprogresserror)<br>[EducationVerifyLimitError](#educationverifylimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/init
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AccountInitPayload](#accountinitpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountAlreadyInitedError](#accountalreadyinitederror)<br>[AccountNotFoundError](#accountnotfounderror)<br>[InvalidInvitationCodeError](#invalidinvitationcodeerror)<br>[MissingInvitationCodeError](#missinginvitationcodeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /account/integrates
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountIntegrateListResponse](#accountintegratelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /account/password
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AccountPasswordPayload](#accountpasswordpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountResponse](#accountresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[CurrentPasswordIncorrectError](#currentpasswordincorrecterror)<br>[InvalidAccountPasswordError](#invalidaccountpassworderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /account/profile
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountResponse](#accountresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /account/profile
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AccountProfilePatchPayload](#accountprofilepatchpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountResponse](#accountresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /activate
|
|
**Accept an invitation without letting an existing session act for another account**
|
|
|
|
Activate account with invitation token
|
|
Token-only activation remains available for legacy clients. When the request already
|
|
carries a console session, that session must belong to the account encoded in the
|
|
invitation before the token is consumed or tenant membership is changed.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ActivatePayload](#activatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Account activated successfully | **application/json**: [ActivationResponse](#activationresponse)<br> |
|
|
| 400 | Already activated or invalid token | **application/json**: [AccountInFreezeError](#accountinfreezeerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AlreadyActivateError](#alreadyactivateerror)<br>[InvitationAccountMismatchError](#invitationaccountmismatcherror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /activate/check
|
|
Check if activation token is valid
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| email | query | | No | string |
|
|
| token | query | | Yes | string |
|
|
| workspace_id | query | | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ActivationCheckResponse](#activationcheckresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| creator_ids | query | Filter by creator account IDs | No | [ string ] |
|
|
| is_created_by_me | query | Filter by creator | No | boolean |
|
|
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
|
|
| mode | query | App mode filter | No | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all |
|
|
| name | query | Filter by app name | No | string |
|
|
| openapi_visible | query | Only return apps with API access enabled | No | boolean |
|
|
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
|
|
| publication_status | query | Filter by published or draft Agent configuration status | No | string, <br>**Available values:** "drafts", "published" |
|
|
| sort_by | query | Sort apps by last modified, recently created, or earliest created | No | string, <br>**Available values:** "earliest_created", "last_modified", "recently_created", <br>**Default:** last_modified |
|
|
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app list | **application/json**: [AgentAppPagination](#agentapppagination)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentAppCreatePayload](#agentappcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent app created successfully | **application/json**: [AgentAppDetailWithSite](#agentappdetailwithsite)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Agent name already exists | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/invite-options
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | query | Workflow app id for in-current-workflow markers | No | string |
|
|
| keyword | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent invite options | **application/json**: [AgentInviteOptionsResponse](#agentinviteoptionsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /agent/{agent_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent app deleted successfully | |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app detail | **application/json**: [AgentAppDetailWithSite](#agentappdetailwithsite)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /agent/{agent_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentAppUpdatePayload](#agentappupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app updated successfully | **application/json**: [AgentAppDetailWithSite](#agentappdetailwithsite)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/api-access
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent service API access | **application/json**: [AgentApiAccessResponse](#agentapiaccessresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/api-enable
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentApiStatusPayload](#agentapistatuspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent service API status updated | **application/json**: [AgentApiAccessResponse](#agentapiaccessresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNotPublishedError](#agentnotpublishederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/api-keys
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent service API keys | **application/json**: [ApiKeyList](#apikeylist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/api-keys
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent service API key created | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
|
|
| 400 | Maximum keys exceeded | **application/json**: [MaxKeysExceededError](#maxkeysexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNotPublishedError](#agentnotpublishederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /agent/{agent_id}/api-keys/{api_key_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| api_key_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent service API key deleted | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/audio-to-text
|
|
Transcribe audio using the current Agent debug configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"draft_type"**: string, <br>**Available values:** "debug_build", "draft", <br>**Default:** draft, **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Audio transcription successful | **application/json**: [AudioTranscriptResponse](#audiotranscriptresponse)<br> |
|
|
| 400 | Bad request - Speech to text disabled or unsupported audio | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NoAudioUploadedError](#noaudiouploadederror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportSpeechToTextError](#providernotsupportspeechtotexterror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[SpeechToTextDisabledError](#speechtotextdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent or build draft not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Audio file too large | **application/json**: [AudioTooLargeError](#audiotoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedAudioTypeError](#unsupportedaudiotypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/build-chat/finalize
|
|
Run a build-draft Agent App turn that asks the agent to push config updates
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent, build draft, or conversation not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /agent/{agent_id}/build-draft
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent build draft discarded | **application/json**: [AgentSimpleResultResponse](#agentsimpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentBuildSandboxNotFoundError](#agentbuildsandboxnotfounderror)<br>[AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/build-draft
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent build draft | **application/json**: [AgentBuildDraftResponse](#agentbuilddraftresponse)<br> |
|
|
| 404 | Agent build draft not found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /agent/{agent_id}/build-draft
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent build draft saved | **application/json**: [AgentBuildDraftResponse](#agentbuilddraftresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/build-draft/apply
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent build draft applied | **application/json**: [AgentBuildDraftApplyResponse](#agentbuilddraftapplyresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentBuildSandboxNotFoundError](#agentbuildsandboxnotfounderror)<br>[AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [AgentHomeSnapshotTooLargeError](#agenthomesnapshottoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentHomeSnapshotCreateFailedError](#agenthomesnapshotcreatefailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/build-draft/checkout
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentBuildDraftCheckoutPayload](#agentbuilddraftcheckoutpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent build draft checked out | **application/json**: [AgentBuildDraftResponse](#agentbuilddraftresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentBuildSandboxNotFoundError](#agentbuildsandboxnotfounderror)<br>[AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/chat-messages
|
|
Get Agent App chat messages for a conversation with pagination
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| conversation_id | query | Conversation ID | Yes | string |
|
|
| first_id | query | First message ID for pagination | No | string |
|
|
| limit | query | Number of messages to return (1-100) | No | integer, <br>**Default:** 20 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MessageInfiniteScrollPaginationResponse](#messageinfinitescrollpaginationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent or conversation not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/chat-messages/{message_id}/suggested-questions
|
|
Get suggested questions for an Agent App message
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| message_id | path | Message ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Suggested questions retrieved successfully | **application/json**: [SuggestedQuestionsResponse](#suggestedquestionsresponse)<br> |
|
|
| 400 | App or model provider unavailable, or generation failed | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 401 | Account authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions or suggested questions disabled | **application/json**: [AppSuggestedQuestionsAfterAnswerDisabledError](#appsuggestedquestionsafteranswerdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent, message, or conversation not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Unexpected server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/chat-messages/{task_id}/stop
|
|
Stop a running Agent App chat message generation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| task_id | path | Task ID to stop | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app composer state | **application/json**: [AgentAppComposerResponse](#agentappcomposerresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /agent/{agent_id}/composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app composer saved | **application/json**: [AgentAppComposerResponse](#agentappcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/composer/candidates
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app composer candidates | **application/json**: [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/composer/validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent app composer validation result | **application/json**: [AgentComposerValidateResponse](#agentcomposervalidateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config files | **application/json**: [AgentConfigFileListResponse](#agentconfigfilelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/config/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentConfigFileUploadPayload](#agentconfigfileuploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Uploaded config file | **application/json**: [AgentConfigFileUploadResponse](#agentconfigfileuploadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/config/files/batch
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentConfigFilesUploadPayload](#agentconfigfilesuploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Bound config files | **application/json**: [AgentConfigFilesUploadResponse](#agentconfigfilesuploadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /agent/{agent_id}/config/files/{name}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config file name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config file deleted | **application/json**: [AgentConfigDeleteResponse](#agentconfigdeleteresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/files/{name}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config file name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config file download URL | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/files/{name}/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config file name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Preview | **application/json**: [AgentConfigFilePreviewResponse](#agentconfigfilepreviewresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/manifest
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent config manifest | **application/json**: [AgentConfigManifestResponse](#agentconfigmanifestresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/skills
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skills | **application/json**: [AgentConfigSkillListResponse](#agentconfigskilllistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/config/skills/upload
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Uploaded config skill | **application/json**: [AgentConfigSkillUploadResponse](#agentconfigskilluploadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /agent/{agent_id}/config/skills/{name}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill deleted | **application/json**: [AgentConfigDeleteResponse](#agentconfigdeleteresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/skills/{name}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill download URL | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/skills/{name}/files/content
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/skills/{name}/files/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| path | query | Normalized zip member path inside the skill package | Yes | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill file download URL | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/skills/{name}/files/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| path | query | Normalized zip member path inside the skill package | Yes | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill file preview | **application/json**: [AgentConfigSkillFilePreviewResponse](#agentconfigskillfilepreviewresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/config/skills/{name}/inspect
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill inspect view | **application/json**: [AgentConfigSkillInspectResponse](#agentconfigskillinspectresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/copy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentAppCopyPayload](#agentappcopypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent app copied successfully | **application/json**: [AgentAppDetailWithSite](#agentappdetailwithsite)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/debug-conversation/refresh
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent debug conversation refreshed | **application/json**: [AgentDebugConversationRefreshResponse](#agentdebugconversationrefreshresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentBuildSandboxNotFoundError](#agentbuildsandboxnotfounderror)<br>[AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/features
|
|
Update an Agent App's presentation features (opener, follow-up, citations, ...)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentAppFeaturesPayload](#agentappfeaturespayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Features updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Invalid configuration | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/feedbacks
|
|
Create or update Agent App message feedback
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppMessageFeedbackPayload](#appmessagefeedbackpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Feedback updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[MessageFeedbackRatingRequiredError](#messagefeedbackratingrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent or message not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/log-sources
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent log sources | **application/json**: [AgentLogSourceListResponse](#agentlogsourcelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/logs
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| keyword | query | Search query, answer, or conversation name | No | string |
|
|
| limit | query | Page size | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| sort_by | query | Sort by created_at or updated_at | No | string, <br>**Default:** updated_at |
|
|
| sort_order | query | Sort order: asc or desc | No | string, <br>**Default:** desc |
|
|
| source | query | Deprecated single source filter | No | string |
|
|
| sources | query | Filter by one or more source IDs, e.g. webapp:<app_id> or workflow:<app_id>. Exact workflow:<app_id>:<workflow_id>:<version>:<node_id> IDs remain supported. | No | [ string ] |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
| status | query | Deprecated single status filter | No | string |
|
|
| statuses | query | Filter by one or more of success, failed, paused | No | [ string ] |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent logs | **application/json**: [AgentLogListResponse](#agentloglistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/logs/{conversation_id}/messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| keyword | query | Search query, answer, or conversation name | No | string |
|
|
| limit | query | Page size | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| sort_by | query | Sort by created_at or updated_at | No | string, <br>**Default:** updated_at |
|
|
| sort_order | query | Sort order: asc or desc | No | string, <br>**Default:** desc |
|
|
| source | query | Deprecated single source filter | No | string |
|
|
| sources | query | Filter by one or more source IDs, e.g. webapp:<app_id> or workflow:<app_id>. Exact workflow:<app_id>:<workflow_id>:<version>:<node_id> IDs remain supported. | No | [ string ] |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
| status | query | Deprecated single status filter | No | string |
|
|
| statuses | query | Filter by one or more of success, failed, paused | No | [ string ] |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| conversation_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent log messages | **application/json**: [AgentLogMessageListResponse](#agentlogmessagelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/messages/{message_id}
|
|
Get Agent App message details by ID
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| message_id | path | Message ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Message retrieved successfully | **application/json**: [MessageDetailResponse](#messagedetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent or message not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/publish
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentPublishPayload](#agentpublishpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent draft published | **application/json**: [AgentPublishResponse](#agentpublishresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentModelNotConfiguredError](#agentmodelnotconfigurederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/referencing-workflows
|
|
List workflow apps that reference this Agent App's bound Agent (read-only)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Referencing workflows listed successfully | **application/json**: [AgentReferencingWorkflowsResponse](#agentreferencingworkflowsresponse)<br> |
|
|
| 404 | Agent not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/sandbox
|
|
Get basic information for an Agent App conversation sandbox
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| caller_id | query | Agent App caller ID | Yes | string |
|
|
| caller_type | query | | Yes | string, <br>**Available values:** "build_draft", "conversation" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Sandbox information returned | **application/json**: [SandboxInfoResponse](#sandboxinforesponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/sandbox/files
|
|
List a directory in an Agent App conversation sandbox
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| caller_id | query | Agent App caller ID | Yes | string |
|
|
| caller_type | query | | Yes | string, <br>**Available values:** "build_draft", "conversation" |
|
|
| path | query | Binding path: relative paths start in Workspace; exact `~` and paths beginning with `~/` start in Home; `~user` is an ordinary relative path from Workspace; absolute paths remain absolute; `..` and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction | No | string, <br>**Default:** . |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Listing returned | **application/json**: [SandboxListResponse](#sandboxlistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentBackendUnreachableError](#agentbackendunreachableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [InspectorUnavailableError](#inspectorunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/sandbox/files/download
|
|
Create a ToolFile from one Agent App Binding file and return its download URL
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentSandboxDownloadPayload](#agentsandboxdownloadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Download URL returned | **application/json**: [SandboxDownloadResponse](#sandboxdownloadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentBackendUnreachableError](#agentbackendunreachableerror)<br>[BindingFileDownloadUnavailableError](#bindingfiledownloadunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [InspectorUnavailableError](#inspectorunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/sandbox/files/read
|
|
Read a text/binary preview file in an Agent App conversation sandbox
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| caller_id | query | Agent App caller ID | Yes | string |
|
|
| caller_type | query | | Yes | string, <br>**Available values:** "build_draft", "conversation" |
|
|
| path | query | Binding path: relative paths start in Workspace; exact `~` and paths beginning with `~/` start in Home; `~user` is an ordinary relative path from Workspace; absolute paths remain absolute; `..` and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Preview returned | **application/json**: [SandboxReadResponse](#sandboxreadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentBackendUnreachableError](#agentbackendunreachableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [InspectorUnavailableError](#inspectorunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/statistics/summary
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| source | query | Filter by a structured webapp:<app_id> or workflow:<app_id> source ID. Legacy invoke sources and exact workflow version/node source IDs remain supported. | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent monitoring summary and chart data | **application/json**: [AgentStatisticSummaryEnvelopeResponse](#agentstatisticsummaryenveloperesponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/text-to-audio
|
|
Preview an Agent TTS voice or read an Agent chat message
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TextToSpeechPayload](#texttospeechpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Generated audio bytes in the provider audio format | **audio/aac**: binary<br>**audio/flac**: binary<br>**audio/mp4**: binary<br>**audio/mpeg**: binary<br>**audio/ogg**: binary<br>**audio/wav**: binary<br>**audio/webm**: binary<br> |
|
|
| 400 | Invalid text or voice | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportTextToSpeechError](#providernotsupporttexttospeecherror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/text-to-audio/voices
|
|
Get available TTS voices for an Agent and language
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | Agent ID | Yes | string (uuid) |
|
|
| language | query | Language code | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | TTS voices retrieved successfully | **application/json**: [TextToSpeechVoiceListResponse](#texttospeechvoicelistresponse)<br> |
|
|
| 400 | Invalid language parameter | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Agent not found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/trace
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent tracing settings | **application/json**: [AppTraceResponse](#apptraceresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/trace
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppTracePayload](#apptracepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Updated Agent tracing settings | **application/json**: [AppTraceResponse](#apptraceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidTracingConfigError](#invalidtracingconfigerror)<br>[TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [TraceConfigNotFoundError](#traceconfignotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TracingConfigConflictError](#tracingconfigconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/trace-capabilities
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| tracing_provider | query | Tracing provider name | Yes | string |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Provider support declarations | **application/json**: [TraceProviderCapabilitiesResponse](#traceprovidercapabilitiesresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /agent/{agent_id}/trace-config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| tracing_provider | query | Tracing provider name | Yes | string |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent provider configuration deleted | |
|
|
| 400 | Bad Request | **application/json**: [UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[TraceConfigNotFoundError](#traceconfignotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/trace-config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| tracing_provider | query | Tracing provider name | Yes | string |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Masked Agent provider configuration | **application/json**: [TraceAppConfigResponse](#traceappconfigresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /agent/{agent_id}/trace-config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TraceConfigPayload](#traceconfigpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent provider updated | **application/json**: [TraceAppConfigResponse](#traceappconfigresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidTracingConfigError](#invalidtracingconfigerror)<br>[TracingConfigVerificationFailedError](#tracingconfigverificationfailederror)<br>[TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[TraceConfigNotFoundError](#traceconfignotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TracingConfigConflictError](#tracingconfigconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/trace-config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TraceConfigPayload](#traceconfigpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent provider configured | **application/json**: [TraceAppConfigResponse](#traceappconfigresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidTracingConfigError](#invalidtracingconfigerror)<br>[TracingConfigVerificationFailedError](#tracingconfigverificationfailederror)<br>[TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TraceConfigAlreadyExistsError](#traceconfigalreadyexistserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/trace-runs/{message_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_execution_id | query | Select an Agent node invocation within this run | No | string (uuid) |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Frozen trace destination and export state | **application/json**: [TraceRunStatusResponse](#tracerunstatusresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [TracingNodeNotFoundError](#tracingnodenotfounderror)<br>[TracingSourceNotFoundError](#tracingsourcenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/trace-runs/{message_id}/retry
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_execution_id | query | Select an Agent node invocation within this run | No | string (uuid) |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TraceRunRetryPayload](#tracerunretrypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Retry state for the same frozen destination | **application/json**: [TraceRunStatusResponse](#tracerunstatusresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [TracingNodeNotFoundError](#tracingnodenotfounderror)<br>[TracingRunNotFoundError](#tracingrunnotfounderror)<br>[TracingSourceNotFoundError](#tracingsourcenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TracingAlreadyAcceptedError](#tracingalreadyacceptederror)<br>[TracingDuplicateAcknowledgementRequiredError](#tracingduplicateacknowledgementrequirederror)<br>[TracingRetryNotAllowedError](#tracingretrynotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/versions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent versions | **application/json**: [AgentConfigSnapshotListResponse](#agentconfigsnapshotlistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /agent/{agent_id}/versions/{version_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| version_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent version detail | **application/json**: [AgentConfigSnapshotDetailResponse](#agentconfigsnapshotdetailresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /agent/{agent_id}/versions/{version_id}/restore
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| version_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent version restored | **application/json**: [AgentConfigSnapshotRestoreResponse](#agentconfigsnapshotrestoreresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /all-workspaces
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspacePaginationResponse](#workspacepaginationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /api-based-extension
|
|
Get all API-based extensions for current tenant
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [APIBasedExtensionListResponse](#apibasedextensionlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /api-based-extension
|
|
Create a new API-based extension
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [APIBasedExtensionPayload](#apibasedextensionpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Extension created successfully | **application/json**: [APIBasedExtensionResponse](#apibasedextensionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /api-based-extension/{id}
|
|
Delete API-based extension
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| id | path | Extension ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Extension deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /api-based-extension/{id}
|
|
Get API-based extension by ID
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| id | path | Extension ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [APIBasedExtensionResponse](#apibasedextensionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /api-based-extension/{id}
|
|
Update API-based extension
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| id | path | Extension ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [APIBasedExtensionPayload](#apibasedextensionpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Extension updated successfully | **application/json**: [APIBasedExtensionResponse](#apibasedextensionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /api-key-auth/data-source
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ApiKeyAuthDataSourceListResponse](#apikeyauthdatasourcelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /api-key-auth/data-source/binding
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ApiKeyAuthBindingPayload](#apikeyauthbindingpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [UnsupportedDataSourceApiKeyAuthProviderError](#unsupporteddatasourceapikeyauthprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [DataSourceApiKeyAuthProviderUnavailableError](#datasourceapikeyauthproviderunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /api-key-auth/data-source/{binding_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| binding_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Binding deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /app-dsl-version
|
|
**Get current app DSL version for workflow clipboard compatibility**
|
|
|
|
Get current app DSL version
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AppDslVersionResponse](#appdslversionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /app/prompt-templates
|
|
Get advanced prompt templates based on app mode and model configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_mode | query | Application mode | Yes | string |
|
|
| has_context | query | Whether has context | No | string, <br>**Default:** true |
|
|
| model_mode | query | Model mode | Yes | string |
|
|
| model_name | query | Model name | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Prompt templates retrieved successfully | **application/json**: [AdvancedPromptTemplateResponse](#advancedprompttemplateresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps
|
|
Get list of applications with pagination and filtering
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| creator_ids | query | Filter by creator account IDs | No | [ string ] |
|
|
| is_created_by_me | query | Filter by creator | No | boolean |
|
|
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
|
|
| mode | query | App mode filter | No | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all |
|
|
| name | query | Filter by app name | No | string |
|
|
| openapi_visible | query | Only return apps with API access enabled | No | boolean |
|
|
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
|
|
| sort_by | query | Sort apps by last modified, recently created, or earliest created | No | string, <br>**Available values:** "earliest_created", "last_modified", "recently_created", <br>**Default:** last_modified |
|
|
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AppPagination](#apppagination)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps
|
|
Create a new application
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CreateAppPayload](#createapppayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | App created successfully | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/imports
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppImportPayload](#appimportpayload)<br>**multipart/form-data**: { **"app_id"**: string, **"description"**: string, **"file"**: binary, **"icon"**: string, **"icon_background"**: string, **"icon_type"**: string, **"name"**: string }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Import completed | **application/json**: [Import](#import)<br> |
|
|
| 202 | Import pending confirmation | **application/json**: [Import](#import)<br> |
|
|
| 400 | Import failed | **application/json**: [Import](#import)<br>[InvalidRosterAgentPackageError](#invalidrosteragentpackageerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient import permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [RecommendedAppNotFoundError](#recommendedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Agent name conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Roster Agent package exceeds the size limit | **application/json**: [RosterAgentPackageTooLargeError](#rosteragentpackagetoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [RosterAgentPackageImportFailedError](#rosteragentpackageimportfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [RosterAgentPackageResourceUnavailableError](#rosteragentpackageresourceunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/imports/{app_id}/check-dependencies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dependencies checked | **application/json**: [CheckDependenciesResult](#checkdependenciesresult)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/imports/{import_id}/confirm
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| import_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Import confirmed | **application/json**: [Import](#import)<br> |
|
|
| 400 | Import failed | **application/json**: [Import](#import)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | The draft changed after the export the import is based on | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/recent
|
|
Get recently modified apps for the home Continue Work section
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| limit | query | Number of recently modified apps to return (1-8) | No | integer, <br>**Default:** 8 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RecentAppListResponse](#recentapplistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/starred
|
|
Get applications starred by the current account
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| creator_ids | query | Filter by creator account IDs | No | [ string ] |
|
|
| is_created_by_me | query | Filter by creator | No | boolean |
|
|
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
|
|
| mode | query | App mode filter | No | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all |
|
|
| name | query | Filter by app name | No | string |
|
|
| openapi_visible | query | Only return apps with API access enabled | No | boolean |
|
|
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
|
|
| sort_by | query | Sort apps by last modified, recently created, or earliest created | No | string, <br>**Available values:** "earliest_created", "last_modified", "recently_created", <br>**Default:** last_modified |
|
|
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AppPagination](#apppagination)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/workflows/online-users
|
|
Get workflow online users
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowOnlineUsersPayload](#workflowonlineuserspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow online users retrieved successfully | **application/json**: [WorkflowOnlineUsersResponse](#workflowonlineusersresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}
|
|
Delete application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | App deleted successfully | |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}
|
|
Get application details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}
|
|
Update application details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [UpdateAppPayload](#updateapppayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | App updated successfully | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/advanced-chat/workflow-runs
|
|
**Get advanced chat app workflow run list**
|
|
|
|
Get advanced chat workflow run list
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| last_id | query | Last run ID for pagination | No | string |
|
|
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
|
|
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
|
|
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow runs retrieved successfully | **application/json**: [AdvancedChatWorkflowRunPaginationResponse](#advancedchatworkflowrunpaginationresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/advanced-chat/workflow-runs/count
|
|
**Get advanced chat workflow runs count statistics**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
|
|
| time_range | query | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No | string |
|
|
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow runs count retrieved successfully | **application/json**: [WorkflowRunCountResponse](#workflowruncountresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/preview
|
|
**Preview human input form content and placeholders**
|
|
|
|
Get human input form preview for advanced chat workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HumanInputFormPreviewPayload](#humaninputformpreviewpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Human input form preview | **application/json**: [HumanInputFormPreviewResponse](#humaninputformpreviewresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/form/run
|
|
**Submit human input form preview**
|
|
|
|
Submit human input form preview for advanced chat workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HumanInputFormPreviewSubmitPayload](#humaninputformpreviewsubmitpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Human input form submission result | **application/json**: [HumanInputFormSubmitResponse](#humaninputformsubmitresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/advanced-chat/workflows/draft/human-input/nodes/{node_id}/message-template/test
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MessageTemplateTestRequest](#messagetemplatetestrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MessageTemplateTestResponse](#messagetemplatetestresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/advanced-chat/workflows/draft/iteration/nodes/{node_id}/run
|
|
**Run draft workflow iteration node**
|
|
|
|
Run draft workflow iteration node for advanced chat
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IterationNodeRunPayload](#iterationnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Iteration node run started successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/advanced-chat/workflows/draft/loop/nodes/{node_id}/run
|
|
**Run draft workflow loop node**
|
|
|
|
Run draft workflow loop node for advanced chat
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [LoopNodeRunPayload](#loopnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Loop node run started successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/advanced-chat/workflows/draft/run
|
|
**Run draft workflow**
|
|
|
|
Run draft workflow for advanced chat application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AdvancedChatWorkflowRunPayload](#advancedchatworkflowrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run started successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config files | **application/json**: [AgentConfigFileListResponse](#agentconfigfilelistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/agent/config/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentConfigFileUploadPayload](#agentconfigfileuploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Uploaded config file | **application/json**: [AgentConfigFileUploadResponse](#agentconfigfileuploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/agent/config/files/batch
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentConfigFilesUploadPayload](#agentconfigfilesuploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Bound config files | **application/json**: [AgentConfigFilesUploadResponse](#agentconfigfilesuploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/agent/config/files/{name}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config file name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config file deleted | **application/json**: [AgentConfigDeleteResponse](#agentconfigdeleteresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/files/{name}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config file name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config file download URL | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/files/{name}/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config file name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Preview | **application/json**: [AgentConfigFilePreviewResponse](#agentconfigfilepreviewresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/manifest
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent config manifest | **application/json**: [AgentConfigManifestResponse](#agentconfigmanifestresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/skills
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skills | **application/json**: [AgentConfigSkillListResponse](#agentconfigskilllistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/agent/config/skills/upload
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Uploaded config skill | **application/json**: [AgentConfigSkillUploadResponse](#agentconfigskilluploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/agent/config/skills/{name}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill deleted | **application/json**: [AgentConfigDeleteResponse](#agentconfigdeleteresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/skills/{name}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill download URL | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/skills/{name}/files/content
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/skills/{name}/files/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| path | query | Normalized zip member path inside the skill package | Yes | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill file download URL | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/skills/{name}/files/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| path | query | Normalized zip member path inside the skill package | Yes | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill file preview | **application/json**: [AgentConfigSkillFilePreviewResponse](#agentconfigskillfilepreviewresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/config/skills/{name}/inspect
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| name | path | Config skill name | Yes | string |
|
|
| draft_type | query | Editable draft surface: omit or 'draft' for normal draft, 'debug_build' for build draft | No | string, <br>**Available values:** "debug_build", "draft" |
|
|
| node_id | query | Workflow node ID (workflow composer variant) | No | string |
|
|
| version_id | query | Published snapshot ID for read-only version view | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Config skill inspect view | **application/json**: [AgentConfigSkillInspectResponse](#agentconfigskillinspectresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentNotBoundError](#agentnotbounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/agent/logs
|
|
**Get agent logs**
|
|
|
|
Get agent execution logs for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | query | Conversation UUID | Yes | string |
|
|
| message_id | query | Message UUID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent logs retrieved successfully | **application/json**: [AgentLogResponse](#agentlogresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/annotation-reply/{action}
|
|
Enable or disable annotation reply for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | path | Action to perform (enable/disable) | Yes | string |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AnnotationReplyPayload](#annotationreplypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Action completed successfully | **application/json**: [AnnotationJobStatusResponse](#annotationjobstatusresponse)<br> |
|
|
| 400 | Invalid action | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid payload | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotation-reply/{action}/status/{job_id}
|
|
Get status of annotation reply action job
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | path | Action type | Yes | string |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| job_id | path | Job ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Job status retrieved successfully | **application/json**: [AnnotationJobStatusDetailResponse](#annotationjobstatusdetailresponse)<br> |
|
|
| 400 | Invalid action | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or owned job not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotation-setting
|
|
Get annotation settings for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Annotation settings retrieved successfully | **application/json**: [AnnotationSettingResponse](#annotationsettingresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/annotation-settings/{annotation_setting_id}
|
|
Update annotation settings for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| annotation_setting_id | path | Annotation setting ID | Yes | string (uuid) |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AnnotationSettingUpdatePayload](#annotationsettingupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Settings updated successfully | **application/json**: [AnnotationSettingResponse](#annotationsettingresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/annotations
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| annotation_id | query | Annotation IDs to delete; omitting it clears all annotations of the app | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Annotations deleted successfully | |
|
|
| 400 | Bad Request | **application/json**: [BadRequestError](#badrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotations
|
|
Get annotations for an app with pagination
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| keyword | query | Search keyword | No | string |
|
|
| limit | query | Page size | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Annotations retrieved successfully | **application/json**: [AnnotationList](#annotationlist)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/annotations
|
|
Create a new annotation for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CreateAnnotationPayload](#createannotationpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Annotation created successfully | **application/json**: [Annotation](#annotation)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/annotations/batch-import
|
|
Batch import annotations from CSV file with rate limiting and security checks
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Import started, or CSV/subscription validation failed (error_msg) | **application/json**: [AnnotationBatchImportResponse](#annotationbatchimportresponse)<br> |
|
|
| 400 | Missing, multiple, empty or invalid file | **application/json**: [NoFileUploadedError](#nofileuploadederror)<br>[TooManyFilesError](#toomanyfileserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 413 | File too large | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too many requests or concurrent imports | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Import infrastructure failed | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotations/batch-import-status/{job_id}
|
|
Get status of batch import job
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| job_id | path | Job ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Job status retrieved successfully | **application/json**: [AnnotationJobStatusDetailResponse](#annotationjobstatusdetailresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or owned job not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Import status could not be read | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotations/count
|
|
Get count of message annotations for the app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Annotation count retrieved successfully | **application/json**: [AnnotationCountResponse](#annotationcountresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotations/export
|
|
Export all annotations for an app with CSV injection protection
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Annotations exported successfully | **application/json**: [AnnotationExportList](#annotationexportlist)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/annotations/{annotation_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| annotation_id | path | | Yes | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Annotation deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/annotations/{annotation_id}
|
|
Update or delete an annotation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| annotation_id | path | Annotation ID | Yes | string (uuid) |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [UpdateAnnotationPayload](#updateannotationpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Annotation updated successfully | **application/json**: [Annotation](#annotation)<br> |
|
|
| 204 | Annotation deleted successfully | |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/annotations/{annotation_id}/hit-histories
|
|
Get hit histories for an annotation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| annotation_id | path | Annotation ID | Yes | string (uuid) |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| limit | query | Page size | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Hit histories retrieved successfully | **application/json**: [AnnotationHitHistoryList](#annotationhithistorylist)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/api-enable
|
|
Enable or disable app API
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppApiStatusPayload](#appapistatuspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API status updated successfully | **application/json**: [AppDetail](#appdetail)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/audio-to-text
|
|
Transcript audio to text for chat messages
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | App ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Audio transcription successful | **application/json**: [AudioTranscriptResponse](#audiotranscriptresponse)<br> |
|
|
| 400 | Bad request - No audio uploaded or unsupported type | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NoAudioUploadedError](#noaudiouploadederror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportSpeechToTextError](#providernotsupportspeechtotexterror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[SpeechToTextDisabledError](#speechtotextdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Audio file too large | **application/json**: [AudioTooLargeError](#audiotoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedAudioTypeError](#unsupportedaudiotypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/chat-conversations
|
|
Get chat conversations with pagination and filtering
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| annotation_status | query | Annotation status filter | No | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| keyword | query | Search keyword | No | string |
|
|
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| sort_by | query | Sort field and direction | No | string, <br>**Available values:** "-created_at", "-updated_at", "created_at", "updated_at", <br>**Default:** -updated_at |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConversationWithSummaryPagination](#conversationwithsummarypagination)<br> |
|
|
| 400 | Invalid date range | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 401 | Authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid query parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/chat-conversations/{conversation_id}
|
|
Delete a chat conversation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | path | Conversation ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Conversation deleted successfully | |
|
|
| 401 | Authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or conversation not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ConversationNotFoundError](#conversationnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/chat-conversations/{conversation_id}
|
|
Get chat conversation details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | path | Conversation ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConversationDetail](#conversationdetail)<br> |
|
|
| 401 | Authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or conversation not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ConversationNotFoundError](#conversationnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/chat-messages
|
|
Get chat messages for a conversation with pagination
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | query | Conversation ID | Yes | string |
|
|
| first_id | query | First message ID for pagination | No | string |
|
|
| limit | query | Number of messages to return (1-100) | No | integer, <br>**Default:** 20 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MessageInfiniteScrollPaginationResponse](#messageinfinitescrollpaginationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Conversation not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/chat-messages/{message_id}/suggested-questions
|
|
Get suggested questions for a message
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| message_id | path | Message ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Suggested questions retrieved successfully | **application/json**: [SuggestedQuestionsResponse](#suggestedquestionsresponse)<br> |
|
|
| 400 | App or model provider unavailable, or generation failed | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 401 | Account authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions or suggested questions disabled | **application/json**: [AppSuggestedQuestionsAfterAnswerDisabledError](#appsuggestedquestionsafteranswerdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App, message, or conversation not found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Unexpected server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/chat-messages/{task_id}/stop
|
|
Stop a running chat message generation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| task_id | path | Task ID to stop | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/completion-conversations
|
|
Get completion conversations with pagination and filtering
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| annotation_status | query | Annotation status filter | No | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| keyword | query | Search keyword | No | string |
|
|
| limit | query | Page size (1-100) | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConversationPagination](#conversationpagination)<br> |
|
|
| 400 | Invalid date range | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 401 | Authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid query parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/completion-conversations/{conversation_id}
|
|
Delete a completion conversation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | path | Conversation ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Conversation deleted successfully | |
|
|
| 401 | Authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or conversation not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ConversationNotFoundError](#conversationnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/completion-conversations/{conversation_id}
|
|
Get completion conversation details with messages
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | path | Conversation ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConversationMessageDetail](#conversationmessagedetail)<br> |
|
|
| 401 | Authentication required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or conversation not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ConversationNotFoundError](#conversationnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/completion-messages
|
|
Generate completion message for debugging
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CompletionMessagePayload](#completionmessagepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Completion generated successfully | |
|
|
| 400 | Invalid request parameters | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/completion-messages/{task_id}/stop
|
|
Stop a running completion message generation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| task_id | path | Task ID to stop | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/conversation-variables
|
|
Get conversation variables for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| conversation_id | query | Conversation ID to filter variables | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Conversation variables retrieved successfully | **application/json**: [PaginatedConversationVariableResponse](#paginatedconversationvariableresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/convert-to-workflow
|
|
**Convert basic mode of chatbot app to workflow mode**
|
|
|
|
Convert application to workflow mode
|
|
Convert expert mode of chatbot app to workflow mode
|
|
Convert Completion App to Workflow App
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ConvertToWorkflowPayload](#converttoworkflowpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Application converted to workflow successfully | **application/json**: [NewAppResponse](#newappresponse)<br> |
|
|
| 400 | Application cannot be converted | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/copy
|
|
Create a copy of an existing application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID to copy | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CopyAppPayload](#copyapppayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | App copied successfully | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
|
|
| 202 | App copy requires confirmation | **application/json**: [AppImportResponse](#appimportresponse)<br> |
|
|
| 400 | App copy failed | **application/json**: [AppImportResponse](#appimportresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/export
|
|
Export application configuration as DSL
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID to export | Yes | string (uuid) |
|
|
| format | query | Export format; defaults to ifpkg for all Apps | No | string, <br>**Available values:** "ifpkg", "yaml" |
|
|
| include_secret | query | Include secrets in export | No | boolean |
|
|
| version_id | query | Published Agent version ID to export; requires a paid plan on Cloud. If omitted, exports the shared draft, falling back to the active snapshot when no draft exists. | No | string (uuid) |
|
|
| workflow_id | query | Specific workflow ID to export | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | App exported successfully | **application/json**: [AppExportResponse](#appexportresponse)<br>**application/zip**: binary<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [RosterAgentPackageExportFailedError](#rosteragentpackageexportfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/feedbacks
|
|
Create or update message feedback (like/dislike)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppMessageFeedbackPayload](#appmessagefeedbackpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Feedback updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[MessageFeedbackRatingRequiredError](#messagefeedbackratingrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Message not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/icon
|
|
Update application icon
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppIconPayload](#appiconpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Icon updated successfully | **application/json**: [AppDetail](#appdetail)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/messages/{message_id}
|
|
Get message details by ID
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| message_id | path | Message ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Message retrieved successfully | **application/json**: [MessageDetailResponse](#messagedetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Message not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/model-config
|
|
**Modify the app model config and dataset joins in one request transaction**
|
|
|
|
Update application model configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppModelConfigPayload](#appmodelconfigpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model configuration updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Invalid configuration | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/name
|
|
Check if app name is available
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppNamePayload](#appnamepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Name availability checked | **application/json**: [AppDetail](#appdetail)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/network-access-group
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | App network access group binding retrieved successfully | **application/json**: [AppNetworkAccessGroupResponse](#appnetworkaccessgroupresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NetworkAccessUnsupportedAppModeError](#networkaccessunsupportedappmodeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}/network-access-group
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppNetworkAccessGroupUpdatePayload](#appnetworkaccessgroupupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | App network access group binding updated successfully | **application/json**: [AppNetworkAccessGroupMutationResponse](#appnetworkaccessgroupmutationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NetworkAccessInvalidInputError](#networkaccessinvalidinputerror)<br>[NetworkAccessUnsupportedAccessPointsError](#networkaccessunsupportedaccesspointserror)<br>[NetworkAccessUnsupportedAppModeError](#networkaccessunsupportedappmodeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NetworkAccessGroupNotFoundError](#networkaccessgroupnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [NetworkAccessVersionConflictError](#networkaccessversionconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/network-access-group/status
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | App network access control entry status retrieved successfully | **application/json**: [AppNetworkAccessGroupStatusResponse](#appnetworkaccessgroupstatusresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NetworkAccessUnsupportedAppModeError](#networkaccessunsupportedappmodeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/publish-to-creators-platform
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RedirectUrlResponse](#redirecturlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/server
|
|
Get MCP server configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP server configuration retrieved successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/server
|
|
Create MCP server configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MCPServerCreatePayload](#mcpservercreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | MCP server configuration created successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | MCP server already exists for this app | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}/server
|
|
Update MCP server configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MCPServerUpdatePayload](#mcpserverupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP server configuration updated successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Server not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/server/refresh
|
|
Refresh MCP server configuration and regenerate server code
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | App ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP server refreshed successfully | **application/json**: [AppMCPServerResponse](#appmcpserverresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Server not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/site
|
|
Update application site configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppSiteUpdatePayload](#appsiteupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Site configuration updated successfully | **application/json**: [AppSiteResponse](#appsiteresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/site-enable
|
|
Enable or disable app site
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppSiteStatusPayload](#appsitestatuspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Site status updated successfully | **application/json**: [AppDetail](#appdetail)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/site/access-token-reset
|
|
Reset access token for application site
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Access token reset successfully | **application/json**: [AppSiteResponse](#appsiteresponse)<br> |
|
|
| 403 | Insufficient permissions (admin/owner required) | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | App or site not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/star
|
|
Remove the current account's star from an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | App not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/star
|
|
Star an application for the current account
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | App not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/average-response-time
|
|
Get average response time statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Average response time statistics retrieved successfully | **application/json**: [AverageResponseTimeStatisticResponse](#averageresponsetimestatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/average-session-interactions
|
|
Get average session interaction statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Average session interaction statistics retrieved successfully | **application/json**: [AverageSessionInteractionStatisticResponse](#averagesessioninteractionstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/daily-conversations
|
|
Get daily conversation statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily conversation statistics retrieved successfully | **application/json**: [DailyConversationStatisticResponse](#dailyconversationstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/daily-end-users
|
|
Get daily terminal/end-user statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily terminal statistics retrieved successfully | **application/json**: [DailyTerminalStatisticResponse](#dailyterminalstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/daily-messages
|
|
Get daily message statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily message statistics retrieved successfully | **application/json**: [DailyMessageStatisticResponse](#dailymessagestatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/token-costs
|
|
Get daily token cost statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily token cost statistics retrieved successfully | **application/json**: [DailyTokenCostStatisticResponse](#dailytokencoststatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/tokens-per-second
|
|
Get tokens per second statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Tokens per second statistics retrieved successfully | **application/json**: [TokensPerSecondStatisticResponse](#tokenspersecondstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/statistics/user-satisfaction-rate
|
|
Get user satisfaction rate statistics for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | User satisfaction rate statistics retrieved successfully | **application/json**: [UserSatisfactionRateStatisticResponse](#usersatisfactionratestatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/text-to-audio
|
|
Convert text to speech for chat messages
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | App ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TextToSpeechPayload](#texttospeechpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Text to speech conversion successful | |
|
|
| 400 | Bad request - Invalid parameters | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportTextToSpeechError](#providernotsupporttexttospeecherror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/text-to-audio/voices
|
|
Get available TTS voices for a specific language
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | App ID | Yes | string (uuid) |
|
|
| language | query | Language code | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | TTS voices retrieved successfully | **application/json**: [TextToSpeechVoiceListResponse](#texttospeechvoicelistresponse)<br> |
|
|
| 400 | Invalid language parameter | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/trace
|
|
Get app tracing configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trace configuration retrieved successfully | **application/json**: [AppTraceResponse](#apptraceresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/trace
|
|
Update app tracing configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AppTracePayload](#apptracepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trace configuration updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidTracingConfigError](#invalidtracingconfigerror)<br>[TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[TraceConfigNotFoundError](#traceconfignotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TracingConfigConflictError](#tracingconfigconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/trace-capabilities
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| tracing_provider | query | Tracing provider name | Yes | string |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Provider support declarations | **application/json**: [TraceProviderCapabilitiesResponse](#traceprovidercapabilitiesresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/trace-config
|
|
**Delete an existing trace app configuration**
|
|
|
|
Delete an existing tracing configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| tracing_provider | query | Tracing provider name | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Tracing configuration deleted successfully | |
|
|
| 400 | Invalid request parameters or unsupported tracing provider | **application/json**: [UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Application or tracing configuration not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[TraceConfigNotFoundError](#traceconfignotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Tracing configuration processing failed | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/trace-config
|
|
Get tracing configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| tracing_provider | query | Tracing provider name | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Tracing configuration retrieved successfully | **application/json**: [TraceAppConfigResponse](#traceappconfigresponse)<br> |
|
|
| 400 | Invalid request parameters or unsupported tracing provider | **application/json**: [TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Application not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Tracing configuration processing failed | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /apps/{app_id}/trace-config
|
|
**Update an existing trace app configuration**
|
|
|
|
Update an existing tracing configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TraceConfigPayload](#traceconfigpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Tracing configuration updated successfully | **application/json**: [TraceAppConfigResponse](#traceappconfigresponse)<br> |
|
|
| 400 | Invalid request parameters or tracing configuration | **application/json**: [InvalidTracingConfigError](#invalidtracingconfigerror)<br>[TracingConfigVerificationFailedError](#tracingconfigverificationfailederror)<br>[TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Application or tracing configuration not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[TraceConfigNotFoundError](#traceconfignotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TracingConfigConflictError](#tracingconfigconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Tracing configuration processing failed | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/trace-config
|
|
**Create a new trace app configuration**
|
|
|
|
Create a new tracing configuration for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TraceConfigPayload](#traceconfigpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Tracing configuration created successfully | **application/json**: [TraceAppConfigResponse](#traceappconfigresponse)<br> |
|
|
| 400 | Invalid request parameters or tracing configuration | **application/json**: [InvalidTracingConfigError](#invalidtracingconfigerror)<br>[TracingConfigVerificationFailedError](#tracingconfigverificationfailederror)<br>[TracingProviderUnavailableError](#tracingproviderunavailableerror)<br>[UnsupportedTracingProviderError](#unsupportedtracingprovidererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Insufficient permissions | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Application not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Tracing configuration already exists | **application/json**: [TraceConfigAlreadyExistsError](#traceconfigalreadyexistserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Tracing configuration processing failed | **application/json**: [TracingConfigProcessingFailedError](#tracingconfigprocessingfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/trace-runs/{source_kind}/{source_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| source_kind | path | | Yes | string, <br>**Available values:** "message", "node", "workflow" |
|
|
| node_execution_id | query | Select an Agent node invocation within this run | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| source_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Frozen trace destination and export state | **application/json**: [TraceRunStatusResponse](#tracerunstatusresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [TracingNodeNotFoundError](#tracingnodenotfounderror)<br>[TracingSourceNotFoundError](#tracingsourcenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/trace-runs/{source_kind}/{source_id}/retry
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| source_kind | path | | Yes | string, <br>**Available values:** "message", "node", "workflow" |
|
|
| node_execution_id | query | Select an Agent node invocation within this run | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| source_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TraceRunRetryPayload](#tracerunretrypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Retry state for the same frozen destination | **application/json**: [TraceRunStatusResponse](#tracerunstatusresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [TracingNodeNotFoundError](#tracingnodenotfounderror)<br>[TracingRunNotFoundError](#tracingrunnotfounderror)<br>[TracingSourceNotFoundError](#tracingsourcenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [TracingAlreadyAcceptedError](#tracingalreadyacceptederror)<br>[TracingDuplicateAcknowledgementRequiredError](#tracingduplicateacknowledgementrequirederror)<br>[TracingRetryNotAllowedError](#tracingretrynotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/trigger-enable
|
|
**Update app trigger (enable/disable)**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserEnable](#parserenable)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkflowTriggerResponse](#workflowtriggerresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[AppTriggerNotFoundError](#apptriggernotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/triggers
|
|
**Get app triggers list**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkflowTriggerListResponse](#workflowtriggerlistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-app-logs
|
|
**Get workflow app logs**
|
|
|
|
Get workflow application execution logs
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| created_at__after | query | Filter logs created after this timestamp | No | dateTime |
|
|
| created_at__before | query | Filter logs created before this timestamp | No | dateTime |
|
|
| created_by_account | query | Filter by account | No | string |
|
|
| created_by_end_user_session_id | query | Filter by end user session ID | No | string |
|
|
| detail | query | Whether to return detailed logs | No | boolean |
|
|
| keyword | query | Search keyword for filtering logs | No | string |
|
|
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number (1-99999) | No | integer, <br>**Default:** 1 |
|
|
| status | query | Execution status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "paused", "running", "scheduled", "stopped", "succeeded" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow app logs retrieved successfully | **application/json**: [WorkflowAppLogPaginationResponse](#workflowapplogpaginationresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs
|
|
**Get workflow run list**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| last_id | query | Last run ID for pagination | No | string |
|
|
| limit | query | Number of items per page (1-100) | No | integer, <br>**Default:** 20 |
|
|
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
|
|
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow runs retrieved successfully | **application/json**: [WorkflowRunPaginationResponse](#workflowrunpaginationresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs/count
|
|
**Get workflow runs count statistics**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| status | query | Workflow run status filter | No | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" |
|
|
| time_range | query | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No | string |
|
|
| triggered_from | query | Filter by trigger source: debugging or app-run. Default: debugging | No | string, <br>**Available values:** "app-run", "debugging" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow runs count retrieved successfully | **application/json**: [WorkflowRunCountResponse](#workflowruncountresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflow-runs/tasks/{task_id}/stop
|
|
**Stop workflow task**
|
|
|
|
Stop running workflow task
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| task_id | path | Task ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Task not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs/{run_id}
|
|
**Get workflow run detail**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run detail retrieved successfully | **application/json**: [WorkflowRunDetailResponse](#workflowrundetailresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs/{run_id}/node-executions
|
|
**Get workflow run node execution list**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node executions retrieved successfully | **application/json**: [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs/{run_id}/node-executions/{node_execution_id}/children
|
|
Get the internal node executions of one workflow tool invocation
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Root application ID | Yes | string (uuid) |
|
|
| node_execution_id | path | Tool execution ID | Yes | string |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Internal node executions retrieved successfully | **application/json**: [WorkflowToolNodeExecutionListResponse](#workflowtoolnodeexecutionlistresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files
|
|
List a directory in a workflow Agent node sandbox
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Workflow Agent node ID | Yes | string |
|
|
| workflow_run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
| node_execution_id | query | Workflow node execution ID | Yes | string |
|
|
| path | query | Binding path: relative paths start in Workspace; exact `~` and paths beginning with `~/` start in Home; `~user` is an ordinary relative path from Workspace; absolute paths remain absolute; `..` and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction | No | string, <br>**Default:** . |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Listing returned | **application/json**: [SandboxListResponse](#sandboxlistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentBackendUnreachableError](#agentbackendunreachableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [InspectorUnavailableError](#inspectorunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files/download
|
|
Create a ToolFile from one workflow Agent Binding file and return its download URL
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
| workflow_run_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowAgentSandboxDownloadPayload](#workflowagentsandboxdownloadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Download URL returned | **application/json**: [SandboxDownloadResponse](#sandboxdownloadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentBackendUnreachableError](#agentbackendunreachableerror)<br>[BindingFileDownloadUnavailableError](#bindingfiledownloadunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [InspectorUnavailableError](#inspectorunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow-runs/{workflow_run_id}/agent-nodes/{node_id}/sandbox/files/read
|
|
Read a text/binary preview file in a workflow Agent node sandbox
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Workflow Agent node ID | Yes | string |
|
|
| workflow_run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
| node_execution_id | query | Workflow node execution ID | Yes | string |
|
|
| path | query | Binding path: relative paths start in Workspace; exact `~` and paths beginning with `~/` start in Home; `~user` is an ordinary relative path from Workspace; absolute paths remain absolute; `..` and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Preview returned | **application/json**: [SandboxReadResponse](#sandboxreadresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NoActiveBindingError](#noactivebindingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [AgentBackendUnreachableError](#agentbackendunreachableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [InspectorUnavailableError](#inspectorunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/comments
|
|
**Get all comments for a workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Comments retrieved successfully | **application/json**: [WorkflowCommentBasicList](#workflowcommentbasiclist)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflow/comments
|
|
**Create a new workflow comment**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowCommentCreatePayload](#workflowcommentcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Comment created successfully | **application/json**: [WorkflowCommentCreate](#workflowcommentcreate)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/comments/mention-users
|
|
**Get all users in current tenant for mentions**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Mentionable users retrieved successfully | **application/json**: [WorkflowCommentMentionUsersPayload](#workflowcommentmentionuserspayload)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/workflow/comments/{comment_id}
|
|
**Delete a workflow comment**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Comment deleted successfully | |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/comments/{comment_id}
|
|
**Get a specific workflow comment**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Comment retrieved successfully | **application/json**: [WorkflowCommentDetail](#workflowcommentdetail)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}/workflow/comments/{comment_id}
|
|
**Update a workflow comment**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowCommentUpdatePayload](#workflowcommentupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Comment updated successfully | **application/json**: [WorkflowCommentUpdate](#workflowcommentupdate)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflow/comments/{comment_id}/replies
|
|
**Add a reply to a workflow comment**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowCommentReplyPayload](#workflowcommentreplypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Reply created successfully | **application/json**: [WorkflowCommentReplyCreate](#workflowcommentreplycreate)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/workflow/comments/{comment_id}/replies/{reply_id}
|
|
**Delete a comment reply**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
| reply_id | path | Reply ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Reply deleted successfully | |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}/workflow/comments/{comment_id}/replies/{reply_id}
|
|
**Update a comment reply**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
| reply_id | path | Reply ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowCommentReplyPayload](#workflowcommentreplypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Reply updated successfully | **application/json**: [WorkflowCommentReplyUpdate](#workflowcommentreplyupdate)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflow/comments/{comment_id}/resolve
|
|
**Resolve a workflow comment**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| comment_id | path | Comment ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Comment resolved successfully | **application/json**: [WorkflowCommentResolve](#workflowcommentresolve)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/statistics/average-app-interactions
|
|
Get workflow average app interaction statistics
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Average app interaction statistics retrieved successfully | **application/json**: [WorkflowAverageAppInteractionStatisticResponse](#workflowaverageappinteractionstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/statistics/daily-conversations
|
|
Get workflow daily runs statistics
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily runs statistics retrieved successfully | **application/json**: [WorkflowDailyRunsStatisticResponse](#workflowdailyrunsstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/statistics/daily-terminals
|
|
Get workflow daily terminals statistics
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily terminals statistics retrieved successfully | **application/json**: [WorkflowDailyTerminalsStatisticResponse](#workflowdailyterminalsstatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflow/statistics/token-costs
|
|
Get workflow daily token cost statistics
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| end | query | End date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
| start | query | Start date and time (YYYY-MM-DD HH:MM) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Daily token cost statistics retrieved successfully | **application/json**: [WorkflowDailyTokenCostStatisticResponse](#workflowdailytokencoststatisticresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows
|
|
**Get published workflows**
|
|
|
|
Get all published workflows for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| limit | query | | No | integer, <br>**Default:** 10 |
|
|
| named_only | query | | No | boolean |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
| user_id | query | | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published workflows retrieved successfully | **application/json**: [WorkflowPaginationResponse](#workflowpaginationresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/default-workflow-block-configs
|
|
**Get default block config**
|
|
|
|
Get default block configurations for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default block configurations retrieved successfully | **application/json**: [DefaultBlockConfigsResponse](#defaultblockconfigsresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/default-workflow-block-configs/{block_type}
|
|
**Get default block config**
|
|
|
|
Get default block configuration by type
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| block_type | path | Block type | Yes | string |
|
|
| q | query | | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default block configuration retrieved successfully | **application/json**: [DefaultBlockConfigResponse](#defaultblockconfigresponse)<br> |
|
|
| 404 | Block type not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft
|
|
**Get draft workflow**
|
|
|
|
Get draft workflow for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow retrieved successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
|
|
| 404 | Draft workflow not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft
|
|
**Sync draft workflow**
|
|
|
|
Sync draft workflow configuration
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SyncDraftWorkflowPayload](#syncdraftworkflowpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow synced successfully | **application/json**: [SyncDraftWorkflowResponse](#syncdraftworkflowresponse)<br> |
|
|
| 400 | Invalid workflow configuration | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DraftWorkflowNotSyncError](#draftworkflownotsyncerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/conversation-variables
|
|
Get conversation variables for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Conversation variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| 404 | Draft workflow not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/conversation-variables
|
|
Update conversation variables for workflow draft
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ConversationVariableUpdatePayload](#conversationvariableupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Conversation variables updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/environment-variables
|
|
**Get draft workflow**
|
|
|
|
Get environment variables for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Environment variables retrieved successfully | **application/json**: [EnvironmentVariableListResponse](#environmentvariablelistresponse)<br> |
|
|
| 404 | Draft workflow not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/environment-variables
|
|
Update environment variables for workflow draft
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EnvironmentVariableUpdatePayload](#environmentvariableupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Environment variables updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/features
|
|
Update draft workflow features
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowFeaturesPayload](#workflowfeaturespayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow features updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/delivery-test
|
|
**Test human input delivery**
|
|
|
|
Test human input delivery for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HumanInputDeliveryTestPayload](#humaninputdeliverytestpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Human input delivery test result | **application/json**: [EmptyObjectResponse](#emptyobjectresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/preview
|
|
**Preview human input form content and placeholders**
|
|
|
|
Get human input form preview for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HumanInputFormPreviewPayload](#humaninputformpreviewpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Human input form preview | **application/json**: [HumanInputFormPreviewResponse](#humaninputformpreviewresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/form/run
|
|
**Submit human input form preview**
|
|
|
|
Submit human input form preview for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HumanInputFormPreviewSubmitPayload](#humaninputformpreviewsubmitpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Human input form submission result | **application/json**: [HumanInputFormSubmitResponse](#humaninputformsubmitresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/human-input/nodes/{node_id}/message-template/test
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MessageTemplateTestRequest](#messagetemplatetestrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MessageTemplateTestResponse](#messagetemplatetestresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/iteration/nodes/{node_id}/run
|
|
**Run draft workflow iteration node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IterationNodeRunPayload](#iterationnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow iteration node run started successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/loop/nodes/{node_id}/run
|
|
**Run draft workflow loop node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [LoopNodeRunPayload](#loopnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow loop node run started successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snapshot_id | query | | No | string |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow agent composer state | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow agent composer saved | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/candidates
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow agent composer candidates | **application/json**: [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/copy-from-roster
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowComposerCopyFromRosterPayload](#workflowcomposercopyfromrosterpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow roster agent copied to inline agent | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentVersionConflictError](#agentversionconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/impact
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow agent composer impact | **application/json**: [AgentComposerImpactResponse](#agentcomposerimpactresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/save-to-roster
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow agent composer saved to roster | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/agent-composer/validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow agent composer validation result | **application/json**: [AgentComposerValidateResponse](#agentcomposervalidateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/last-run
|
|
Get last run result for draft workflow node
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node last run retrieved successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Node last run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/run
|
|
**Run draft workflow node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DraftWorkflowNodeRunPayload](#draftworkflownoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node run started successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/nodes/{node_id}/trigger/run
|
|
**Poll for trigger events and execute single node when event arrives**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger event received and node executed successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 400 | Trigger run failed | **application/json**: [WorkflowTriggerRunErrorResponse](#workflowtriggerrunerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/workflows/draft/nodes/{node_id}/variables
|
|
Delete all variables for a specific node
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| node_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Node variables deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/nodes/{node_id}/variables
|
|
Get variables for a specific node
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/run
|
|
**Run draft workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DraftWorkflowRunPayload](#draftworkflowrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow run started successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs
|
|
Snapshot of every node's declared outputs for a draft workflow run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node outputs | **application/json**: [WorkflowRunSnapshotView](#workflowrunsnapshotview)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/events
|
|
Server-Sent Events stream of inspector deltas for a draft workflow run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node output event stream | **application/json**: [EventStreamResponse](#eventstreamresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}
|
|
One node's declared outputs for a draft workflow run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID inside the workflow graph | Yes | string |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node output detail | **application/json**: [NodeOutputsView](#nodeoutputsview)<br> |
|
|
| 404 | Workflow run / node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NodeNotInWorkflowRunError](#nodenotinworkflowrunerror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
|
|
Full value for one declared output, including signed download URL for files.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID inside the workflow graph | Yes | string |
|
|
| output_name | path | Declared output name as exposed by Composer | Yes | string |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node output preview | **application/json**: [OutputPreviewView](#outputpreviewview)<br> |
|
|
| 404 | Workflow run / node / output not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NodeNotInWorkflowRunError](#nodenotinworkflowrunerror)<br>[NodeOutputNotDeclaredError](#nodeoutputnotdeclarederror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/system-variables
|
|
Get system variables for workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | System variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/trigger/run
|
|
**Poll for trigger events and execute full workflow when event arrives**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DraftWorkflowTriggerRunPayload](#draftworkflowtriggerrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger event received and workflow executed successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 400 | Trigger run failed | **application/json**: [WorkflowTriggerRunErrorResponse](#workflowtriggerrunerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/draft/trigger/run-all
|
|
**Full workflow debug when the start node is a trigger**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DraftWorkflowTriggerRunAllPayload](#draftworkflowtriggerrunallpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow executed successfully | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 400 | Trigger run failed | **application/json**: [WorkflowTriggerRunErrorResponse](#workflowtriggerrunerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/workflows/draft/variables
|
|
Delete all draft workflow variables
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Workflow variables deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/variables
|
|
**Get draft workflow**
|
|
|
|
Get draft workflow variables
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| limit | query | Items per page | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow variables retrieved successfully | **application/json**: [WorkflowDraftVariableListWithoutValueResponse](#workflowdraftvariablelistwithoutvalueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/workflows/draft/variables/{variable_id}
|
|
Delete a workflow variable
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Variable deleted successfully | |
|
|
| 404 | Variable not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/draft/variables/{variable_id}
|
|
Get a specific workflow variable
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| variable_id | path | Variable ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable retrieved successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 404 | Variable not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /apps/{app_id}/workflows/draft/variables/{variable_id}
|
|
Update a workflow variable
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowDraftVariableUpdatePayload](#workflowdraftvariableupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable updated successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 404 | Variable not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /apps/{app_id}/workflows/draft/variables/{variable_id}/reset
|
|
Reset a workflow variable to its default value
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| variable_id | path | Variable ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable reset successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 204 | Variable reset (no content) | |
|
|
| 404 | Variable not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/publish
|
|
**Get published workflow**
|
|
|
|
Get published workflow for an application
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published workflow retrieved successfully, or null if not found | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/publish
|
|
**Publish workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [PublishWorkflowPayload](#publishworkflowpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow published successfully | **application/json**: [WorkflowPublishResponse](#workflowpublishresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs
|
|
Snapshot of every node's declared outputs for a published workflow run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node outputs | **application/json**: [WorkflowRunSnapshotView](#workflowrunsnapshotview)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/events
|
|
Server-Sent Events stream of inspector deltas for a published workflow run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node output event stream | **application/json**: [EventStreamResponse](#eventstreamresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}
|
|
One node's declared outputs for a published workflow run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID inside the workflow graph | Yes | string |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node output detail | **application/json**: [NodeOutputsView](#nodeoutputsview)<br> |
|
|
| 404 | Workflow run / node not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NodeNotInWorkflowRunError](#nodenotinworkflowrunerror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/published/runs/{run_id}/node-outputs/{node_id}/{output_name}/preview
|
|
Full value for one declared output of a published run.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| node_id | path | Node ID inside the workflow graph | Yes | string |
|
|
| output_name | path | Declared output name as exposed by Composer | Yes | string |
|
|
| run_id | path | Workflow run ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run node output preview | **application/json**: [OutputPreviewView](#outputpreviewview)<br> |
|
|
| 404 | Workflow run / node / output not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[NodeNotInWorkflowRunError](#nodenotinworkflowrunerror)<br>[NodeOutputNotDeclaredError](#nodeoutputnotdeclarederror)<br>[WorkflowRunNotFoundError](#workflowrunnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{app_id}/workflows/triggers/webhook
|
|
**Get webhook trigger for a node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | query | | Yes | string |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WebhookTriggerResponse](#webhooktriggerresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[WebhookTriggerNotFoundError](#webhooktriggernotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{app_id}/workflows/{workflow_id}
|
|
**Delete workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| workflow_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Workflow deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /apps/{app_id}/workflows/{workflow_id}
|
|
**Update workflow attributes**
|
|
|
|
Update workflow by ID
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| workflow_id | path | Workflow ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowUpdatePayload](#workflowupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow updated successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Workflow not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{app_id}/workflows/{workflow_id}/restore
|
|
Restore a published workflow version into the draft workflow
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | Application ID | Yes | string (uuid) |
|
|
| workflow_id | path | Published workflow ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow restored successfully | **application/json**: [WorkflowRestoreResponse](#workflowrestoreresponse)<br> |
|
|
| 400 | Source workflow must be published | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Workflow not found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /apps/{resource_id}/api-keys
|
|
Get all API keys for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| resource_id | path | App ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API keys retrieved successfully | **application/json**: [ApiKeyList](#apikeylist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /apps/{resource_id}/api-keys
|
|
Create a new API key for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| resource_id | path | App ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | API key created successfully | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
|
|
| 400 | Maximum keys exceeded | **application/json**: [MaxKeysExceededError](#maxkeysexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNotPublishedError](#agentnotpublishederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /apps/{resource_id}/api-keys/{api_key_id}
|
|
Delete an API key for an app
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| api_key_id | path | API key ID | Yes | string (uuid) |
|
|
| resource_id | path | App ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | API key deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /auth/plugin/datasource/default-list
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default datasource credentials retrieved successfully | **application/json**: [DatasourceProviderAuthListResponse](#datasourceproviderauthlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /auth/plugin/datasource/list
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource credentials retrieved successfully | **application/json**: [DatasourceProviderAuthListResponse](#datasourceproviderauthlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /auth/plugin/datasource/{provider_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource credentials retrieved successfully | **application/json**: [DatasourceCredentialListResponse](#datasourcecredentiallistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /auth/plugin/datasource/{provider_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceCredentialPayload](#datasourcecredentialpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource credential created successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /auth/plugin/datasource/{provider_id}/custom-client
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /auth/plugin/datasource/{provider_id}/custom-client
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceCustomClientPayload](#datasourcecustomclientpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource OAuth custom client saved successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /auth/plugin/datasource/{provider_id}/default
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceDefaultPayload](#datasourcedefaultpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /auth/plugin/datasource/{provider_id}/delete
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceCredentialDeletePayload](#datasourcecredentialdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /auth/plugin/datasource/{provider_id}/update
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceCredentialUpdatePayload](#datasourcecredentialupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Datasource credential updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /auth/plugin/datasource/{provider_id}/update-name
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceUpdateNamePayload](#datasourceupdatenamepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /billing/invoices
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [BillingInvoiceResponse](#billinginvoiceresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Billing operation failed | **application/json**: [BillingOperationFailedErrorResponse](#billingoperationfailederrorresponse)<br>[BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Billing unavailable | **application/json**: [BillingUnavailableErrorResponse](#billingunavailableerrorresponse)<br>[BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /billing/subscription
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| interval | query | Billing interval | Yes | string, <br>**Available values:** "month", "year" |
|
|
| plan | query | Subscription plan | Yes | string, <br>**Available values:** "professional", "team" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [BillingSubscriptionResponse](#billingsubscriptionresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid subscription query | **application/json**: [BillingUnprocessableEntityErrorResponse](#billingunprocessableentityerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Billing operation failed | **application/json**: [BillingOperationFailedErrorResponse](#billingoperationfailederrorresponse)<br>[BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Billing unavailable | **application/json**: [BillingUnavailableErrorResponse](#billingunavailableerrorresponse)<br>[BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /code-based-extension
|
|
Get code-based extension data by module name
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| module | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [CodeBasedExtensionResponse](#codebasedextensionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /compliance/download
|
|
Get compliance document download link
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| doc_name | query | Compliance document name | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ComplianceDownloadResponse](#compliancedownloadresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ComplianceDownloadForbiddenError](#compliancedownloadforbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ComplianceDocumentNotFoundError](#compliancedocumentnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid compliance download query | **application/json**: [BillingUnprocessableEntityErrorResponse](#billingunprocessableentityerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Compliance download rate limit exceeded | **application/json**: [ComplianceRateLimitErrorResponse](#complianceratelimiterrorresponse)<br>[BillingRequestInProgressError](#billingrequestinprogresserror)<br>[ComplianceRateLimitError](#complianceratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Compliance download failed | **application/json**: [BillingOperationFailedErrorResponse](#billingoperationfailederrorresponse)<br>[BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Billing unavailable | **application/json**: [BillingUnavailableErrorResponse](#billingunavailableerrorresponse)<br>[BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /data-source/integrates
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [DataSourceIntegrateListResponse](#datasourceintegratelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /data-source/integrates/{binding_id}/{action}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | path | | Yes | string |
|
|
| binding_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidActionError](#invalidactionerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets
|
|
Get list of datasets
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| creator_ids | query | Filter by creator account IDs | No | [ string ] |
|
|
| ids | query | Filter by dataset IDs | No | [ string ] |
|
|
| include_all | query | Include all datasets | No | boolean |
|
|
| keyword | query | Search keyword | No | string |
|
|
| limit | query | Number of items per page | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasets retrieved successfully | **application/json**: [DatasetListResponse](#datasetlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets
|
|
Create a new dataset
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasetCreatePayload](#datasetcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Dataset created successfully | **application/json**: [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/api-base-info
|
|
Get dataset API base information
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API base info retrieved successfully | **application/json**: [ApiBaseUrlResponse](#apibaseurlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/api-keys
|
|
Get dataset API keys
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API keys retrieved successfully | **application/json**: [ApiKeyList](#apikeylist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/api-keys
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasetApiKeyCreatePayload](#datasetapikeycreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API key created successfully | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
|
|
| 400 | Maximum keys exceeded | **application/json**: [MaxKeysExceededError](#maxkeysexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/api-keys/{api_key_id}
|
|
Delete dataset API key
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| api_key_id | path | API key ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | API key deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/batch_import_status/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| job_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Batch import status | **application/json**: [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/external
|
|
Create external knowledge dataset
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ExternalDatasetCreatePayload](#externaldatasetcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | External dataset created successfully | **application/json**: [DatasetDetailResponse](#datasetdetailresponse)<br> |
|
|
| 400 | Invalid parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/external-knowledge-api
|
|
Get external knowledge API templates
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | Search keyword | No | string |
|
|
| limit | query | Number of items per page | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | External API templates retrieved successfully | **application/json**: [ExternalKnowledgeApiListResponse](#externalknowledgeapilistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/external-knowledge-api
|
|
Create external knowledge API template
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ExternalKnowledgeApiPayload](#externalknowledgeapipayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | External API template created successfully | **application/json**: [ExternalKnowledgeApiResponse](#externalknowledgeapiresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/external-knowledge-api/{external_knowledge_api_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| external_knowledge_api_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | External knowledge API deleted successfully | |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/external-knowledge-api/{external_knowledge_api_id}
|
|
Get external knowledge API template details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| external_knowledge_api_id | path | External knowledge API ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | External API template retrieved successfully | **application/json**: [ExternalKnowledgeApiResponse](#externalknowledgeapiresponse)<br> |
|
|
| 404 | Template not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/external-knowledge-api/{external_knowledge_api_id}
|
|
Update external knowledge API template
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| external_knowledge_api_id | path | External knowledge API ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ExternalKnowledgeApiPayload](#externalknowledgeapipayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | External API template updated successfully | **application/json**: [ExternalKnowledgeApiResponse](#externalknowledgeapiresponse)<br> |
|
|
| 404 | Template not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/external-knowledge-api/{external_knowledge_api_id}/use-check
|
|
Check if external knowledge API is being used
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| external_knowledge_api_id | path | External knowledge API ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Usage check completed successfully | **application/json**: [UsageCountResponse](#usagecountresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/indexing-estimate
|
|
Estimate dataset indexing cost
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IndexingEstimatePayload](#indexingestimatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Indexing estimate calculated successfully | **application/json**: [IndexingEstimateResponse](#indexingestimateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [DatasetAccessDeniedError](#datasetaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [IndexingEstimateError](#indexingestimateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/init
|
|
Initialize dataset with documents
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeConfig](#knowledgeconfig)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dataset initialized successfully | **application/json**: [DatasetAndDocumentResponse](#datasetanddocumentresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/knowledge-fs-upgrade-jobs
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Recoverable upgrade jobs from the Classic Knowledge Base to an Agent Knowledge Base | **application/json**: [KnowledgeFSUpgradeJobListResponse](#knowledgefsupgradejoblistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/metadata/built-in
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Built-in fields retrieved successfully | **application/json**: [DatasetMetadataBuiltInFieldsResponse](#datasetmetadatabuiltinfieldsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/notion-indexing-estimate
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NotionEstimatePayload](#notionestimatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [IndexingEstimate](#indexingestimate)<br> |
|
|
| 400 | Bad Request | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [IndexingEstimateError](#indexingestimateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/process-rule
|
|
Get dataset document processing rules
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| document_id | query | Document ID (optional) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Process rules retrieved successfully | **application/json**: [ProcessRuleResponse](#processruleresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/retrieval-setting
|
|
Get dataset retrieval settings
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Retrieval settings retrieved successfully | **application/json**: [RetrievalSettingResponse](#retrievalsettingresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/retrieval-setting/{vector_type}
|
|
Get mock dataset retrieval settings by vector type
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| vector_type | path | Vector store type | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Mock retrieval settings retrieved successfully | **application/json**: [RetrievalSettingResponse](#retrievalsettingresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Dataset deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}
|
|
Get dataset details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dataset retrieved successfully | **application/json**: [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}
|
|
Update dataset details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasetUpdatePayload](#datasetupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dataset updated successfully | **application/json**: [DatasetDetailWithPartialMembersResponse](#datasetdetailwithpartialmembersresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/api-keys/{status}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| status | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/auto-disable-logs
|
|
Get dataset auto disable logs
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Auto disable logs retrieved successfully | **application/json**: [AutoDisableLogsResponse](#autodisablelogsresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/batch/{batch}/indexing-estimate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| batch | path | | Yes | string |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Indexing estimate calculated successfully | **application/json**: [IndexingEstimateResponse](#indexingestimateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [DocumentAlreadyFinishedError](#documentalreadyfinishederror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [DatasetAccessDeniedError](#datasetaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [IndexingEstimateError](#indexingestimateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/batch/{batch}/indexing-status
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| batch | path | | Yes | string |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Indexing status retrieved successfully | **application/json**: [DocumentStatusListResponse](#documentstatuslistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}/documents
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | query | Document IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Documents deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents
|
|
Get documents in a dataset
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| fetch | query | | No | string, <br>**Default:** false |
|
|
| keyword | query | Search keyword. | No | string |
|
|
| limit | query | Page size. | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number. | No | integer, <br>**Default:** 1 |
|
|
| sort | query | Sort by field. | No | string, <br>**Default:** -created_at |
|
|
| status | query | Document status. | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Documents retrieved successfully | **application/json**: [DocumentWithSegmentsListResponse](#documentwithsegmentslistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeConfig](#knowledgeconfig)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Documents created successfully | **application/json**: [DatasetAndDocumentResponse](#datasetanddocumentresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/download-zip
|
|
**Stream a ZIP archive containing the requested uploaded documents**
|
|
|
|
Download selected dataset documents as a single ZIP archive (upload-file only)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DocumentBatchDownloadZipPayload](#documentbatchdownloadzippayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | ZIP archive downloaded successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/generate-summary
|
|
**Generate summary index for specified documents**
|
|
|
|
Generate summary index for documents
|
|
This endpoint checks if the dataset configuration supports summary generation
|
|
(indexing_technique must be 'high_quality' and summary_index_setting.enable must be true),
|
|
then asynchronously generates summary indexes for the provided documents.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [GenerateSummaryPayload](#generatesummarypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Summary generation started successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Invalid request or dataset configuration | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/metadata
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MetadataOperationData](#metadataoperationdata)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Documents metadata updated successfully | |
|
|
| 404 | Dataset, document, or metadata not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/status/{action}/batch
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| document_id | query | Document IDs | No | [ string ] |
|
|
| action | path | | Yes | string |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidActionError](#invalidactionerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}/documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Document deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}
|
|
Get document details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| metadata | query | Metadata inclusion (all/only/without) | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Document retrieved successfully | **application/json**: [DocumentDetailResponse](#documentdetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidMetadataError](#invalidmetadataerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/download
|
|
Get a signed download URL for a dataset document's original uploaded file
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Download URL generated successfully | **application/json**: [UrlResponse](#urlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/indexing-estimate
|
|
Estimate document indexing cost
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Indexing estimate calculated successfully | **application/json**: [IndexingEstimateResponse](#indexingestimateresponse)<br> |
|
|
| 400 | Document already finished | **application/json**: [DocumentAlreadyFinishedError](#documentalreadyfinishederror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [DatasetAccessDeniedError](#datasetaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [IndexingEstimateError](#indexingestimateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/indexing-status
|
|
Get document indexing status
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Indexing status retrieved successfully | **application/json**: [DocumentStatusResponse](#documentstatusresponse)<br> |
|
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /datasets/{dataset_id}/documents/{document_id}/metadata
|
|
Update document metadata
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DocumentMetadataUpdatePayload](#documentmetadataupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Document metadata updated successfully | **application/json**: [SimpleResultMessageResponse](#simpleresultmessageresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/notion/sync
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [DatasetAccessDeniedError](#datasetaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/pipeline-execution-log
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Pipeline execution log retrieved successfully | **application/json**: [DocumentPipelineExecutionLogResponse](#documentpipelineexecutionlogresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/pause
|
|
**pause document**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Document paused successfully | |
|
|
| 400 | Bad Request | **application/json**: [DocumentIndexingError](#documentindexingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ArchivedDocumentImmutableError](#archiveddocumentimmutableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/resume
|
|
**recover document**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Document resumed successfully | |
|
|
| 400 | Bad Request | **application/json**: [DocumentIndexingError](#documentindexingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ArchivedDocumentImmutableError](#archiveddocumentimmutableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/processing/{action}
|
|
Update document processing status (pause/resume)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | path | Action to perform (pause/resume) | Yes | string |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Processing status updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Invalid action | **application/json**: [InvalidActionError](#invalidactionerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/{document_id}/rename
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DocumentRenamePayload](#documentrenamepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Document renamed successfully | **application/json**: [DocumentResponse](#documentresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/{document_id}/segment
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SegmentCreatePayload](#segmentcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Segment created successfully | **application/json**: [SegmentDetailResponse](#segmentdetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segment/{action}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | path | Action | Yes | string |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | query | Segment IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidActionError](#invalidactionerror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}/documents/{document_id}/segments
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | query | Segment IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Segments deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/segments
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| enabled | query | | No | string, <br>**Default:** all |
|
|
| hit_count_gte | query | | No | integer |
|
|
| keyword | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
| status | query | | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Segments retrieved successfully | **application/json**: [ConsoleSegmentListResponse](#consolesegmentlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/{document_id}/segments/batch_import
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [BatchImportPayload](#batchimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Batch import started | **application/json**: [SegmentBatchImportStatusResponse](#segmentbatchimportstatusresponse)<br> |
|
|
| 500 | Batch import failed | **application/json**: [ErrorMessageResponse](#errormessageresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Segment ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Segment deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Segment ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SegmentUpdatePayload](#segmentupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Segment updated successfully | **application/json**: [SegmentDetailResponse](#segmentdetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Parent segment ID | Yes | string (uuid) |
|
|
| keyword | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Child chunks retrieved successfully | **application/json**: [ChildChunkListResponse](#childchunklistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Parent segment ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChildChunkBatchUpdatePayload](#childchunkbatchupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Child chunks updated successfully | **application/json**: [ChildChunkBatchUpdateResponse](#childchunkbatchupdateresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [ChildChunkIndexingError](#childchunkindexingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Parent segment ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChildChunkCreatePayload](#childchunkcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Child chunk created successfully | **application/json**: [ChildChunkDetailResponse](#childchunkdetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [ProviderNotInitializeError](#providernotinitializeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [ChildChunkIndexingError](#childchunkindexingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| child_chunk_id | path | Child chunk ID | Yes | string (uuid) |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Parent segment ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Child chunk deleted successfully | |
|
|
| 500 | Internal Server Error | **application/json**: [ChildChunkDeleteIndexError](#childchunkdeleteindexerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| child_chunk_id | path | Child chunk ID | Yes | string (uuid) |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
| segment_id | path | Parent segment ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChildChunkUpdatePayload](#childchunkupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Child chunk updated successfully | **application/json**: [ChildChunkDetailResponse](#childchunkdetailresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [ChildChunkIndexingError](#childchunkindexingerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/summary-status
|
|
**Get summary index generation status for a document**
|
|
|
|
Get summary index generation status for a document
|
|
Returns:
|
|
- total_segments: Total number of segments in the document
|
|
- summary_status: Dictionary with status counts
|
|
- completed: Number of summaries completed
|
|
- generating: Number of summaries being generated
|
|
- error: Number of summaries with errors
|
|
- not_started: Number of segments without summary records
|
|
- timeout: Number of summaries that timed out
|
|
- summaries: List of summary records with status and content preview
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| document_id | path | Document ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Summary status retrieved successfully | **application/json**: [DocumentSummaryStatusResponse](#documentsummarystatusresponse)<br> |
|
|
| 404 | Document not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/documents/{document_id}/website-sync
|
|
**sync website document**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| document_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ArchivedDocumentImmutableError](#archiveddocumentimmutableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/error-docs
|
|
Get dataset error documents
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Error documents retrieved successfully | **application/json**: [ErrorDocsResponse](#errordocsresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/external-hit-testing
|
|
Test external knowledge retrieval for dataset
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ExternalHitTestingPayload](#externalhittestingpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | External hit testing completed successfully | **application/json**: [ExternalHitTestingResponse](#externalhittestingresponse)<br> |
|
|
| 400 | Invalid parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/hit-testing
|
|
Test dataset knowledge retrieval
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HitTestingPayload](#hittestingpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Hit testing completed successfully | **application/json**: [HitTestingResponse](#hittestingresponse)<br> |
|
|
| 400 | Invalid parameters | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/indexing-status
|
|
Get dataset indexing status
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Indexing status retrieved successfully | **application/json**: [DocumentStatusListResponse](#documentstatuslistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/knowledge-fs-upgrades
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Upgrade availability from the Classic Knowledge Base to an Agent Knowledge Base | **application/json**: [KnowledgeFSUpgradePreparationResponse](#knowledgefsupgradepreparationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/knowledge-fs-upgrades
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the Dataset upgrade safe to retry | Yes | string |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSUpgradeStartPayload](#knowledgefsupgradestartpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Upgrade from the Classic Knowledge Base to an Agent Knowledge Base accepted | **application/json**: [KnowledgeFSUpgradeJobResponse](#knowledgefsupgradejobresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsUpgradeModelsUnavailableError](#knowledgefsupgrademodelsunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/knowledge-fs-upgrades/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Status of the upgrade from the Classic Knowledge Base to an Agent Knowledge Base | **application/json**: [KnowledgeFSUpgradeJobResponse](#knowledgefsupgradejobresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/knowledge-fs-upgrades/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Retry of the upgrade from the Classic Knowledge Base to an Agent Knowledge Base accepted | **application/json**: [KnowledgeFSUpgradeRetryResponse](#knowledgefsupgraderetryresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/metadata
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Metadata retrieved successfully | **application/json**: [DatasetMetadataListResponse](#datasetmetadatalistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/metadata
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MetadataArgs](#metadataargs)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Metadata created successfully | **application/json**: [DatasetMetadataResponse](#datasetmetadataresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/metadata/built-in/{action}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | path | | Yes | string |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Action completed successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{dataset_id}/metadata/{metadata_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| metadata_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Metadata deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /datasets/{dataset_id}/metadata/{metadata_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| metadata_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MetadataUpdatePayload](#metadataupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Metadata updated successfully | **application/json**: [DatasetMetadataResponse](#datasetmetadataresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/notion/sync
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [DatasetAccessDeniedError](#datasetaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/permission-part-users
|
|
Get dataset permission user list
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Permission users retrieved successfully | **application/json**: [PartialMemberListResponse](#partialmemberlistresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Dataset not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/queries
|
|
Get dataset query history
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
| limit | query | Number of items per page | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Query history retrieved successfully | **application/json**: [DatasetQueryListResponse](#datasetquerylistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/related-apps
|
|
Get applications related to dataset
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Related apps retrieved successfully | **application/json**: [RelatedAppListResponse](#relatedapplistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{dataset_id}/retry
|
|
**retry document**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DocumentRetryPayload](#documentretrypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Documents retry started successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{dataset_id}/use-check
|
|
Check if dataset is in use
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dataset use status retrieved successfully | **application/json**: [UsageCheckResponse](#usagecheckresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /datasets/{resource_id}/api-keys
|
|
Get all API keys for a dataset
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| resource_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API keys retrieved successfully | **application/json**: [ApiKeyList](#apikeylist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /datasets/{resource_id}/api-keys
|
|
Create a new API key for a dataset
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| resource_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | API key created successfully | **application/json**: [ApiKeyItem](#apikeyitem)<br> |
|
|
| 400 | Maximum keys exceeded | **application/json**: [MaxKeysExceededError](#maxkeysexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /datasets/{resource_id}/api-keys/{api_key_id}
|
|
Delete an API key for a dataset
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| api_key_id | path | API key ID | Yes | string (uuid) |
|
|
| resource_id | path | Dataset ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | API key deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /email-code-login
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailCodeSendPayload](#emailcodesendpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountBannedError](#accountbannederror)<br>[AccountInFreezeError](#accountinfreezeerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[TurnstileVerificationFailedError](#turnstileverificationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailCodeLoginRateLimitExceededError](#emailcodeloginratelimitexceedederror)<br>[EmailSendIpLimitError](#emailsendiplimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [EmailCodeLoginServiceUnavailableError](#emailcodeloginserviceunavailableerror)<br>[TurnstileServiceUnavailableError](#turnstileserviceunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /email-code-login/validity
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailCodeLoginPayload](#emailcodeloginpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountBannedError](#accountbannederror)<br>[AccountInFreezeError](#accountinfreezeerror)<br>[AccountNotFoundError](#accountnotfounderror)<br>[EmailCodeError](#emailcodeerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[LimitExceededError](#limitexceedederror)<br>[NormalizedEmailAlreadyInUseError](#normalizedemailalreadyinuseerror)<br>[NotAllowedCreateWorkspaceError](#notallowedcreateworkspaceerror)<br>[TurnstileVerificationFailedError](#turnstileverificationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [EmailCodeLoginServiceUnavailableError](#emailcodeloginserviceunavailableerror)<br>[TurnstileServiceUnavailableError](#turnstileserviceunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /email-register
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailRegisterResetPayload](#emailregisterresetpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EmailRegisterResetResponse](#emailregisterresetresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountInFreezeError](#accountinfreezeerror)<br>[EmailAlreadyInUseError](#emailalreadyinuseerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[LimitExceededError](#limitexceedederror)<br>[NormalizedEmailAlreadyInUseError](#normalizedemailalreadyinuseerror)<br>[PasswordMismatchError](#passwordmismatcherror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /email-register/send-email
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailRegisterSendPayload](#emailregistersendpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountInFreezeError](#accountinfreezeerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailRegisterRateLimitExceededError](#emailregisterratelimitexceedederror)<br>[EmailSendIpLimitError](#emailsendiplimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /email-register/validity
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailRegisterValidityPayload](#emailregistervaliditypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [VerificationTokenResponse](#verificationtokenresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [EmailCodeError](#emailcodeerror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailRegisterLimitError](#emailregisterlimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /explore/apps
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Language code for recommended app localization | No | string, <br>**Default:** en-US |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RecommendedAppListResponse](#recommendedapplistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /explore/apps/learn-dify
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Language code for recommended app localization | No | string, <br>**Default:** en-US |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [LearnDifyAppListResponse](#learndifyapplistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /explore/apps/{app_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RecommendedAppDetailResponse](#recommendedappdetailresponse)<br> |
|
|
| 404 | Recommended app not found | **application/json**: [RecommendedAppNotFoundError](#recommendedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /features
|
|
**Get current workspace features**
|
|
|
|
Get feature availability and limits for the current workspace
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [FeatureModel](#featuremodel)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /features/vector-space
|
|
**Get vector-space usage and limit for current tenant**
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [VectorSpaceLimitationModel](#vectorspacelimitationmodel)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /files/support-type
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AllowedExtensionsResponse](#allowedextensionsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /files/upload
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [UploadConfig](#uploadconfig)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /files/upload
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary, **"source"**: string, <br>**Available values:** "datasets" }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | File uploaded successfully | **application/json**: [FileResponse](#fileresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [FileExtensionBlockedError](#fileextensionblockederror)<br>[FilenameNotExistsError](#filenamenotexistserror)<br>[NoFileUploadedError](#nofileuploadederror)<br>[TooManyFilesError](#toomanyfileserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [FileTooLargeError](#filetoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /files/{file_id}/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| file_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TextContentResponse](#textcontentresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /forgot-password
|
|
Send password reset email
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ForgotPasswordSendPayload](#forgotpasswordsendpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Email sent successfully | **application/json**: [ForgotPasswordEmailResponse](#forgotpasswordemailresponse)<br> |
|
|
| 400 | Invalid email or rate limit exceeded | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailSendIpLimitError](#emailsendiplimiterror)<br>[PasswordResetRateLimitExceededError](#passwordresetratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /forgot-password/resets
|
|
Reset password with verification token
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ForgotPasswordResetPayload](#forgotpasswordresetpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Password reset successfully | **application/json**: [ForgotPasswordResetResponse](#forgotpasswordresetresponse)<br> |
|
|
| 400 | Invalid token or password mismatch | **application/json**: [AccountNotFoundError](#accountnotfounderror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[PasswordMismatchError](#passwordmismatcherror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /forgot-password/validity
|
|
Verify password reset code
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ForgotPasswordCheckPayload](#forgotpasswordcheckpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Code verified successfully | **application/json**: [ForgotPasswordCheckResponse](#forgotpasswordcheckresponse)<br> |
|
|
| 400 | Invalid code or token | **application/json**: [EmailCodeError](#emailcodeerror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailPasswordResetLimitError](#emailpasswordresetlimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /form/human-input/v2/{form_token}
|
|
Read a frozen v2 form using the current Account's Contact authorization.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| form_token | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Form retrieved | **application/json**: [ConsoleHumanInputV2FormDefinitionResponse](#consolehumaninputv2formdefinitionresponse)<br> |
|
|
| 401 | Login required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Form not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Already submitted | **application/json**: [AlreadySubmittedError](#alreadysubmittederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 410 | Expired | **application/json**: [ExpiredError](#expirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /form/human-input/v2/{form_token}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| form_token | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ConsoleHumanInputV2SubmitPayload](#consolehumaninputv2submitpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Approval accepted | **application/json**: [ConsoleHumanInputV2SubmitResponse](#consolehumaninputv2submitresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidInputError](#invalidinputerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AlreadySubmittedError](#alreadysubmittederror)<br>[WorkflowNotActiveError](#workflownotactiveerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 410 | Gone | **application/json**: [ExpiredError](#expirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /form/human_input/{form_token}
|
|
**Get human input form definition by form token**
|
|
|
|
GET /console/api/form/human_input/<form_token>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| form_token | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConsoleHumanInputFormDefinitionResponse](#consolehumaninputformdefinitionresponse)<br> |
|
|
| 412 | Precondition Failed | **application/json**: [HumanInputFormSubmittedError](#humaninputformsubmittederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /form/human_input/{form_token}
|
|
**Submit human input form by form token**
|
|
|
|
POST /console/api/form/human_input/<form_token>
|
|
|
|
Request body:
|
|
{
|
|
"inputs": {
|
|
"content": "User input content"
|
|
},
|
|
"action": "Approve"
|
|
}
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| form_token | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [HumanInputFormSubmitPayload](#humaninputformsubmitpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConsoleHumanInputFormSubmitResponse](#consolehumaninputformsubmitresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidFormDataError](#invalidformdataerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 412 | Precondition Failed | **application/json**: [HumanInputFormExpiredError](#humaninputformexpirederror)<br>[HumanInputFormSubmittedError](#humaninputformsubmittederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | query | App ID to filter by | No | string |
|
|
| cursor | query | Opaque cursor returned by the previous page | No | string |
|
|
| limit | query | Number of installed apps to return | No | integer, <br>**Default:** 20 |
|
|
| name | query | App name to search for | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [InstalledAppListResponse](#installedapplistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidCursorError](#invalidcursorerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [InstalledAppResponse](#installedappresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[InstalledAppUnavailableError](#installedappunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /installed-apps/{installed_app_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [InstalledAppUpdatePayload](#installedappupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultMessageResponse](#simpleresultmessageresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/audio-to-text
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AudioTranscriptResponse](#audiotranscriptresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NoAudioUploadedError](#noaudiouploadederror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportSpeechToTextError](#providernotsupportspeechtotexterror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[SpeechToTextDisabledError](#speechtotextdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [AudioTooLargeError](#audiotoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedAudioTypeError](#unsupportedaudiotypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/chat-messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChatMessageExplorePayload](#chatmessageexplorepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotChatAppError](#notchatapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/chat-messages/{task_id}/stop
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/completion-messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CompletionMessageExplorePayload](#completionmessageexplorepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotCompletionAppError](#notcompletionapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/completion-messages/{task_id}/stop
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotCompletionAppError](#notcompletionapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/conversations
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| last_id | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| pinned | query | | No | boolean |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ConversationInfiniteScrollPagination](#conversationinfinitescrollpagination)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationCursorNotFoundError](#conversationcursornotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /installed-apps/{installed_app_id}/conversations/{c_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| c_id | path | | Yes | string (uuid) |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Conversation deleted successfully | |
|
|
| 400 | Bad Request | **application/json**: [NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/conversations/{c_id}/name
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| c_id | path | | Yes | string (uuid) |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ConversationRenamePayload](#conversationrenamepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Conversation renamed successfully | **application/json**: [SimpleConversation](#simpleconversation)<br> |
|
|
| 400 | Bad Request | **application/json**: [ConversationNameRequiredError](#conversationnamerequirederror)<br>[NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationFirstMessageNotFoundError](#conversationfirstmessagenotfounderror)<br>[ConversationNotFoundError](#conversationnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /installed-apps/{installed_app_id}/conversations/{c_id}/pin
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| c_id | path | | Yes | string (uuid) |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResultResponse](#resultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /installed-apps/{installed_app_id}/conversations/{c_id}/unpin
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| c_id | path | | Yes | string (uuid) |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResultResponse](#resultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| conversation_id | query | Conversation ID. | Yes | string |
|
|
| first_id | query | The ID of the first chat record on the current page. Omit this value to fetch the latest messages; for subsequent pages, use the first message ID from the current list to fetch older messages. | No | string |
|
|
| limit | query | Number of chat history messages to return per request. | No | integer, <br>**Default:** 20 |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ExploreMessageInfiniteScrollPagination](#exploremessageinfinitescrollpagination)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[MessageCursorNotFoundError](#messagecursornotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/messages/{message_id}/feedbacks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MessageFeedbackPayload](#messagefeedbackpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Feedback submitted successfully | **application/json**: [ResultResponse](#resultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[MessageFeedbackRatingRequiredError](#messagefeedbackratingrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[MessageNotFoundError](#messagenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/messages/{message_id}/more-like-this
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| response_mode | query | | Yes | string, <br>**Available values:** "blocking", "streaming" |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotCompletionAppError](#notcompletionapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[AppMoreLikeThisDisabledError](#appmorelikethisdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[MessageNotFoundError](#messagenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/messages/{message_id}/suggested-questions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuggestedQuestionsResponse](#suggestedquestionsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotChatAppError](#notchatapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[AppSuggestedQuestionsAfterAnswerDisabledError](#appsuggestedquestionsafteranswerdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [ConversationNotFoundError](#conversationnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[MessageNotFoundError](#messagenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/meta
|
|
**Get app meta**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ExploreAppMetaResponse](#exploreappmetaresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/parameters
|
|
**Retrieve app parameters**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [Parameters](#parameters)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /installed-apps/{installed_app_id}/saved-messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| last_id | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SavedMessageInfiniteScrollPagination](#savedmessageinfinitescrollpagination)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotCompletionAppError](#notcompletionapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/saved-messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SavedMessageCreatePayload](#savedmessagecreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResultResponse](#resultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotCompletionAppError](#notcompletionapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /installed-apps/{installed_app_id}/saved-messages/{message_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Saved message deleted successfully | |
|
|
| 400 | Bad Request | **application/json**: [NotCompletionAppError](#notcompletionapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/text-to-audio
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TextToAudioPayload](#texttoaudiopayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **audio/aac**: binary<br>**audio/flac**: binary<br>**audio/mp4**: binary<br>**audio/mpeg**: binary<br>**audio/ogg**: binary<br>**audio/wav**: binary<br>**audio/webm**: binary<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportTextToSpeechError](#providernotsupporttexttospeecherror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/workflows/run
|
|
**Run workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowRunPayload](#workflowrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotWorkflowAppError](#notworkflowapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /installed-apps/{installed_app_id}/workflows/tasks/{task_id}/stop
|
|
**Stop workflow task**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| installed_app_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotWorkflowAppError](#notworkflowapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccessDeniedError](#accessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [InstalledAppNotFoundError](#installedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [WebAppAccessUnavailableError](#webappaccessunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /instruction-generate
|
|
Generate instruction for workflow nodes or general use
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [InstructionGeneratePayload](#instructiongeneratepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Instruction generated successfully | **application/json**: [GeneratorResponse](#generatorresponse)<br> |
|
|
| 400 | Invalid request parameters or flow/workflow not found | **application/json**: [ErrorMessageResponse](#errormessageresponse)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /instruction-generate/template
|
|
Get instruction generation template
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [InstructionTemplatePayload](#instructiontemplatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Template retrieved successfully | **application/json**: [SimpleDataResponse](#simpledataresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/.well-known/jwks.json
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base Capability v2 public keys | **application/json**: [KnowledgeFSJWKSResponse](#knowledgefsjwksresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/features
|
|
Get which Agent Knowledge Base capabilities this deployment offers
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base availability | **application/json**: [KnowledgeFSFeaturesResponse](#knowledgefsfeaturesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/query-stream
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSAdmittedQueryRequest](#knowledgefsadmittedqueryrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base query event stream | **text/event-stream**: string<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/research-tasks/{task_id}/events
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| knowledgeSpaceId | query | | Yes | string |
|
|
| limit | query | | No | integer, <br>**Default:** 25 |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base research task event stream | **text/event-stream**: string<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/source-provider-preview
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSInitialSourcePreviewPayload](#knowledgefsinitialsourcepreviewpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource resources available for an initial Source | **application/json**: [KnowledgeFSInitialSourcePreviewResponse](#knowledgefsinitialsourcepreviewresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/source-provider-preview/jobs
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSInitialWebsiteSourcePreviewPayload](#knowledgefsinitialwebsitesourcepreviewpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Website datasource preview queued | **application/json**: [KnowledgeFSInitialSourcePreviewJobCreateResponse](#knowledgefsinitialsourcepreviewjobcreateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/source-provider-preview/jobs/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Website datasource preview canceled | **application/json**: [KnowledgeFSInitialSourcePreviewJobResponse](#knowledgefsinitialsourcepreviewjobresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/source-provider-preview/jobs/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Website datasource preview status | **application/json**: [KnowledgeFSInitialSourcePreviewJobResponse](#knowledgefsinitialsourcepreviewjobresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| creator_ids | query | Filter by creator account IDs | No | [ string ] |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
| query | query | | No | string |
|
|
| tag_ids | query | Filter by knowledge tag IDs using match-any semantics | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Bases | **application/json**: [KnowledgeFSSpaceListResponse](#knowledgefsspacelistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSpaceCreatePayload](#knowledgefsspacecreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base provisioning accepted | **application/json**: [KnowledgeFSSpaceCreateResponse](#knowledgefsspacecreateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent Knowledge Base deletion accepted | |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base | **application/json**: [KnowledgeFSSpaceDetailResponse](#knowledgefsspacedetailresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSpaceUpdatePayload](#knowledgefsspaceupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base updated | **application/json**: [KnowledgeFSSpaceDetailResponse](#knowledgefsspacedetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/app-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base app bindings | **application/json**: [KnowledgeFSAppBindingListResponse](#knowledgefsappbindinglistresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /knowledge-fs/spaces/{control_space_id}/app-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSAppBindingPayload](#knowledgefsappbindingpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base app binding enabled | **application/json**: [KnowledgeFSAppBindingResponse](#knowledgefsappbindingresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/app-bindings/{caller_kind}/{app_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string |
|
|
| caller_kind | path | | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent Knowledge Base app binding revoked | |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/background-tasks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| task_ids | query | Comma-separated document or document_bulk task IDs for an exact lookup | No | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base background tasks | **application/json**: [KnowledgeFSBackgroundTaskListResponse](#knowledgefsbackgroundtasklistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/background-tasks/{task_kind}/{task_id}/cancel
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| task_id | path | | Yes | string |
|
|
| task_kind | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base background task canceled | **application/json**: [KnowledgeFSBackgroundTaskResponse](#knowledgefsbackgroundtaskresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/background-tasks/{task_kind}/{task_id}/retry
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| task_id | path | | Yes | string |
|
|
| task_kind | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base background task retried | **application/json**: [KnowledgeFSBackgroundTaskResponse](#knowledgefsbackgroundtaskresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/bulk-jobs/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base bulk job | **application/json**: [KnowledgeFSBulkJobResponse](#knowledgefsbulkjobresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/document-references/resolve
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| document_asset_id | query | | Yes | string |
|
|
| document_asset_version | query | | Yes | integer |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Resolved Agent Knowledge Base document reference | **application/json**: [KnowledgeFSResolvedDocumentReferenceResponse](#knowledgefsresolveddocumentreferenceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base documents | **application/json**: [KnowledgeFSDocumentListResponse](#knowledgefsdocumentlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/documents
|
|
Claim a workspace-staged upload. Multipart file bodies remain accepted as a legacy compatibility path.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSDocumentStagedUploadPayload](#knowledgefsdocumentstageduploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base document accepted for processing | **application/json**: [KnowledgeFSDocumentCreateAcceptedResponse](#knowledgefsdocumentcreateacceptedresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [KnowledgeFsRateLimitExceededError](#knowledgefsratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/documents/bulk
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSBulkDocumentDeletePayload](#knowledgefsbulkdocumentdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base document deletions accepted | **application/json**: [KnowledgeFSBulkDeletionAcceptedResponse](#knowledgefsbulkdeletionacceptedresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/documents/reindex
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSDocumentReindexPayload](#knowledgefsdocumentreindexpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document reindex queued | **application/json**: [KnowledgeFSDocumentReindexResponse](#knowledgefsdocumentreindexresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSDocumentDeletePayload](#knowledgefsdocumentdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base document deletion accepted | **application/json**: [KnowledgeFSDurableDeletionAcceptedResponse](#knowledgefsdurabledeletionacceptedresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document | **application/json**: [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSDocumentMetadataPayload](#knowledgefsdocumentmetadatapayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document metadata updated | **application/json**: [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/multimodal
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document multimodal manifest | **application/json**: [KnowledgeFSDocumentMultimodalManifestResponse](#knowledgefsdocumentmultimodalmanifestresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/multimodal/{item_id}/asset
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| variant | query | | No | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
| item_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document multimodal asset | **application/octet-stream**: [BinaryFileResponse](#binaryfileresponse)<br>**image/gif**: [BinaryFileResponse](#binaryfileresponse)<br>**image/jpeg**: [BinaryFileResponse](#binaryfileresponse)<br>**image/png**: [BinaryFileResponse](#binaryfileresponse)<br>**image/webp**: [BinaryFileResponse](#binaryfileresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/outline
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document outline | **application/json**: [KnowledgeFSDocumentOutlineResponse](#knowledgefsdocumentoutlineresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document revisions | **application/json**: [KnowledgeFSDocumentRevisionListResponse](#knowledgefsdocumentrevisionlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions/{revision}/chunks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| query | query | | No | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
| revision | path | | Yes | integer |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document chunks | **application/json**: [KnowledgeFSDocumentChunkListResponse](#knowledgefsdocumentchunklistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| chunk_id | path | | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
| revision | path | | Yes | integer |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base document chunk | **application/json**: [KnowledgeFSDocumentChunkResponse](#knowledgefsdocumentchunkresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/external-access
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base external access | **application/json**: [KnowledgeFSExternalAccessResponse](#knowledgefsexternalaccessresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /knowledge-fs/spaces/{control_space_id}/external-access
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSExternalAccessPayload](#knowledgefsexternalaccesspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base external access updated | **application/json**: [KnowledgeFSExternalAccessResponse](#knowledgefsexternalaccessresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/golden-questions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base golden questions | **application/json**: [KnowledgeFSGoldenQuestionListResponse](#knowledgefsgoldenquestionlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/golden-questions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSGoldenQuestionPayload](#knowledgefsgoldenquestionpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base golden question created | **application/json**: [KnowledgeFSGoldenQuestionResponse](#knowledgefsgoldenquestionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [KnowledgeFsRateLimitExceededError](#knowledgefsratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/golden-questions/bulk-import
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSGoldenQuestionBulkImportPayload](#knowledgefsgoldenquestionbulkimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base golden questions imported | **application/json**: [KnowledgeFSGoldenQuestionBulkImportResponse](#knowledgefsgoldenquestionbulkimportresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [KnowledgeFsRateLimitExceededError](#knowledgefsratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/golden-questions/evidence-matches
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSGoldenQuestionEvidenceMatchPayload](#knowledgefsgoldenquestionevidencematchpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base golden question evidence matches | **application/json**: [KnowledgeFSGoldenQuestionEvidenceMatchResponse](#knowledgefsgoldenquestionevidencematchresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/golden-questions/{question_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| question_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent Knowledge Base golden question deleted | |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/golden-questions/{question_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| question_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSGoldenQuestionPayload](#knowledgefsgoldenquestionpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base golden question updated | **application/json**: [KnowledgeFSGoldenQuestionResponse](#knowledgefsgoldenquestionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/jobs/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base compilation job canceled | **application/json**: [KnowledgeFSDocumentCompilationJobResponse](#knowledgefsdocumentcompilationjobresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/jobs/{job_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base compilation job | **application/json**: [KnowledgeFSDocumentCompilationJobResponse](#knowledgefsdocumentcompilationjobresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/jobs/{job_id}/retry
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| job_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base compilation job retried | **application/json**: [KnowledgeFSDocumentCompilationJobResponse](#knowledgefsdocumentcompilationjobresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| query | query | | No | string |
|
|
| status | query | | No | string, <br>**Available values:** "disabled", "failed", "processing", "queued", "ready" |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base logical documents | **application/json**: [KnowledgeFSLogicalDocumentListResponse](#knowledgefslogicaldocumentlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/logical-documents
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSBulkDocumentAvailabilityPayload](#knowledgefsbulkdocumentavailabilitypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base logical document availability updated | **application/json**: [KnowledgeFSBulkDocumentAvailabilityResponse](#knowledgefsbulkdocumentavailabilityresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/logical-documents/bulk
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSBulkLogicalDocumentDeletePayload](#knowledgefsbulklogicaldocumentdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base logical document deletions accepted | **application/json**: [KnowledgeFSBulkDeletionAcceptedResponse](#knowledgefsbulkdeletionacceptedresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/logical-documents/download-zip
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSDocumentBatchDownloadPayload](#knowledgefsdocumentbatchdownloadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base logical documents ZIP | **application/zip**: [BinaryFileResponse](#binaryfileresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSLogicalDocumentDeletePayload](#knowledgefslogicaldocumentdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base logical document deletion accepted | **application/json**: [KnowledgeFSDurableDeletionAcceptedResponse](#knowledgefsdurabledeletionacceptedresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base logical document | **application/json**: [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSDocumentAvailabilityPayload](#knowledgefsdocumentavailabilitypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base logical document availability updated | **application/json**: [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| document_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base logical document | **application/octet-stream**: [BinaryFileResponse](#binaryfileresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /knowledge-fs/spaces/{control_space_id}/members
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSMembersReplacePayload](#knowledgefsmembersreplacepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base members replaced | **application/json**: [KnowledgeFSPermissionListResponse](#knowledgefspermissionlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/metadata
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 100 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base metadata fields | **application/json**: [KnowledgeFSMetadataFieldListResponse](#knowledgefsmetadatafieldlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/metadata
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSMetadataFieldCreatePayload](#knowledgefsmetadatafieldcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base metadata field created | **application/json**: [KnowledgeFSMetadataFieldResponse](#knowledgefsmetadatafieldresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/metadata/{field_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| expectedRowVersion | query | | Yes | integer |
|
|
| control_space_id | path | | Yes | string |
|
|
| field_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base metadata field deleted | **application/json**: [KnowledgeFSMetadataFieldDeleteResponse](#knowledgefsmetadatafielddeleteresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/metadata/{field_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| field_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSMetadataFieldUpdatePayload](#knowledgefsmetadatafieldupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base metadata field updated | **application/json**: [KnowledgeFSMetadataFieldResponse](#knowledgefsmetadatafieldresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/overview/activity
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | query | | No | string, <br>**Available values:** "document.failed", "document.published", "permission.updated", "profile.published", "query.completed", "query.failed", "query.requested", "settings.updated", "source.failed", "source.synced", "worker.failed" |
|
|
| actor_id | query | | No | string |
|
|
| actor_type | query | | No | string, <br>**Available values:** "member", "system" |
|
|
| cursor | query | | No | string |
|
|
| from_at | query | | No | dateTime |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| resource_type | query | | No | string, <br>**Available values:** "document", "knowledge-space", "permission", "profile", "publication", "query", "source", "worker" |
|
|
| result | query | | No | string, <br>**Available values:** "canceled", "failure", "pending", "success" |
|
|
| to_at | query | | No | dateTime |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base activity | **application/json**: [KnowledgeFSOverviewActivityListResponse](#knowledgefsoverviewactivitylistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/overview/attention
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| include_dismissed | query | | No | boolean |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base attention findings | **application/json**: [KnowledgeFSOverviewAttentionListResponse](#knowledgefsoverviewattentionlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/overview/health
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base health | **application/json**: [KnowledgeFSOverviewHealthResponse](#knowledgefsoverviewhealthresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/overview/inventory
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base inventory | **application/json**: [KnowledgeFSOverviewInventoryResponse](#knowledgefsoverviewinventoryresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/overview/query-outcomes
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| window | query | | No | string, <br>**Available values:** "24h", "30d", "7d", <br>**Default:** 24h |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base query outcomes | **application/json**: [KnowledgeFSOverviewQueryOutcomesResponse](#knowledgefsoverviewqueryoutcomesresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/overview/stats
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| window | query | | No | string, <br>**Available values:** "24h", "30d", "7d", <br>**Default:** 24h |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base Overview statistics | **application/json**: [KnowledgeFSOverviewStatsResponse](#knowledgefsoverviewstatsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/permissions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base permissions | **application/json**: [KnowledgeFSPermissionListResponse](#knowledgefspermissionlistresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/quality/bad-cases
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base bad cases | **application/json**: [KnowledgeFSBadCaseListResponse](#knowledgefsbadcaselistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/quality/bad-cases
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSBadCaseCreatePayload](#knowledgefsbadcasecreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base bad case created | **application/json**: [KnowledgeFSBadCaseResponse](#knowledgefsbadcaseresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/quality/bad-cases/{bad_case_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| bad_case_id | path | | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base bad case | **application/json**: [KnowledgeFSBadCaseResponse](#knowledgefsbadcaseresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/quality/bad-cases/{bad_case_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| bad_case_id | path | | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSBadCaseUpdatePayload](#knowledgefsbadcaseupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base bad case updated | **application/json**: [KnowledgeFSBadCaseResponse](#knowledgefsbadcaseresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/quality/bad-cases/{bad_case_id}/trace-reference
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| bad_case_id | path | | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base bad case trace reference | **application/json**: [KnowledgeFSBadCaseTraceReferenceResponse](#knowledgefsbadcasetracereferenceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/quality/replay-runs
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| mode | query | | No | string, <br>**Available values:** "deep", "fast", "research" |
|
|
| state | query | | No | string, <br>**Available values:** "canceled", "failed", "passed", "queued", "running" |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base quality replay history | **application/json**: [KnowledgeFSQualityReplayListResponse](#knowledgefsqualityreplaylistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/quality/replay-runs
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSQualityReplayPayload](#knowledgefsqualityreplaypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base quality replay queued | **application/json**: [KnowledgeFSQualityReplayResponse](#knowledgefsqualityreplayresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/quality/replay-runs/{run_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| evidence_item_id | query | | No | string (uuid) |
|
|
| control_space_id | path | | Yes | string |
|
|
| run_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base quality replay run | **application/json**: [KnowledgeFSQualityReplayResponse](#knowledgefsqualityreplayresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### ~~[POST] /knowledge-fs/spaces/{control_space_id}/queries~~
|
|
|
|
***DEPRECATED***
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSQueryCreatePayload](#knowledgefsquerycreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base query accepted | **application/json**: [KnowledgeFSQueryResponse](#knowledgefsqueryresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/queries/admission
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSQueryCreatePayload](#knowledgefsquerycreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base streaming query admitted through Dify API | **application/json**: [KnowledgeFSQueryAdmissionResponse](#knowledgefsqueryadmissionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### ~~[POST] /knowledge-fs/spaces/{control_space_id}/query-stream-capability~~
|
|
|
|
***DEPRECATED***
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base Dify API query stream capability | **application/json**: [KnowledgeFSQueryStreamCapabilityResponse](#knowledgefsquerystreamcapabilityresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/research-tasks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base research tasks | **application/json**: [KnowledgeFSResearchTaskListResponse](#knowledgefsresearchtasklistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/research-tasks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSResearchTaskCreatePayload](#knowledgefsresearchtaskcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base research task accepted | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/research-tasks/plan
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSResearchTaskPlanPayload](#knowledgefsresearchtaskplanpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base research task plan | **application/json**: [KnowledgeFSResearchTaskPlanResponse](#knowledgefsresearchtaskplanresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base research task canceled | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base research task | **application/json**: [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}/partials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 25 |
|
|
| control_space_id | path | | Yes | string |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base research task partial evidence | **application/json**: [KnowledgeFSResearchTaskPartialListResponse](#knowledgefsresearchtaskpartiallistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/settings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base settings | **application/json**: [KnowledgeFSSettingsResponse](#knowledgefssettingsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/settings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSettingsPayload](#knowledgefssettingspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base settings updated | **application/json**: [KnowledgeFSSettingsUpdateResponse](#knowledgefssettingsupdateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/settings/migrations/{migration_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| migration_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base settings migration | **application/json**: [KnowledgeFSProfileMigrationResponse](#knowledgefsprofilemigrationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-connections
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source connections | **application/json**: [KnowledgeFSSourceConnectionListResponse](#knowledgefssourceconnectionlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-connections
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceConnectionCreatePayload](#knowledgefssourceconnectioncreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base source connection created | **application/json**: [KnowledgeFSSourceConnectionResponse](#knowledgefssourceconnectionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-connections/{connection_id}/refresh
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| connection_id | path | | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceConnectionRefreshPayload](#knowledgefssourceconnectionrefreshpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source connection refreshed | **application/json**: [KnowledgeFSSourceConnectionResponse](#knowledgefssourceconnectionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-providers
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source providers | **application/json**: [KnowledgeFSSourceProviderListResponse](#knowledgefssourceproviderlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| run_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source workflow | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/cancel
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| run_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceWorkflowCancelPayload](#knowledgefssourceworkflowcancelpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source workflow canceled | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/pages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
| run_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base crawl preview pages | **application/json**: [KnowledgeFSCrawlPreviewPageListResponse](#knowledgefscrawlpreviewpagelistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/retry
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| run_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source workflow retried | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/selection
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| run_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSCrawlPreviewSelectionPayload](#knowledgefscrawlpreviewselectionpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base crawl preview selection accepted | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base sources | **application/json**: [KnowledgeFSSourceListResponse](#knowledgefssourcelistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceCreatePayload](#knowledgefssourcecreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base source created | **application/json**: [KnowledgeFSSourceResponse](#knowledgefssourceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [KnowledgeFsRateLimitExceededError](#knowledgefsratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| documents | query | | No | string, <br>**Available values:** "cascade", "keep", <br>**Default:** cascade |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceDeletePayload](#knowledgefssourcedeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base source deletion accepted | **application/json**: [KnowledgeFSDurableDeletionAcceptedResponse](#knowledgefsdurabledeletionacceptedresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source | **application/json**: [KnowledgeFSSourceResponse](#knowledgefssourceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceUpdatePayload](#knowledgefssourceupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source updated | **application/json**: [KnowledgeFSSourceResponse](#knowledgefssourceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/async-import
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSAsyncSourceImportPayload](#knowledgefsasyncsourceimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base Source import accepted for asynchronous reconciliation | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl-import
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSCrawlImportPayload](#knowledgefscrawlimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base selected website crawl import accepted | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl-preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base source crawl preview accepted | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| bucket | query | | No | string |
|
|
| continuationToken | query | | No | string |
|
|
| maxKeys | query | | No | integer |
|
|
| prefix | query | | No | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source files | **application/json**: [KnowledgeFSSourceFilesResponse](#knowledgefssourcefilesresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/import
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceImportPagesPayload](#knowledgefssourceimportpagespayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source pages imported | **application/json**: [KnowledgeFSSourceImportResponse](#knowledgefssourceimportresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/import-files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceImportFilesPayload](#knowledgefssourceimportfilespayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source files imported | **application/json**: [KnowledgeFSSourceImportResponse](#knowledgefssourceimportresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/pages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source pages | **application/json**: [KnowledgeFSSourcePagesResponse](#knowledgefssourcepagesresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base source sync accepted | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source sync policy | **application/json**: [KnowledgeFSSourceSyncPolicyResponse](#knowledgefssourcesyncpolicyresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceSyncPolicyPayload](#knowledgefssourcesyncpolicypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source sync policy updated | **application/json**: [KnowledgeFSSourceSyncPolicyResponse](#knowledgefssourcesyncpolicyresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/test
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base source credential test | **application/json**: [KnowledgeFSSourceCredentialTestResponse](#knowledgefssourcecredentialtestresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/sources/{source_id}/workflow-imports
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
| source_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSourceWorkflowImportPayload](#knowledgefssourceworkflowimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Agent Knowledge Base durable provider import accepted | **application/json**: [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/tags
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base tags | **application/json**: [KnowledgeFSSpaceTagListResponse](#knowledgefsspacetaglistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /knowledge-fs/spaces/{control_space_id}/tags
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSSpaceTagsReplacePayload](#knowledgefsspacetagsreplacepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base tags replaced | **application/json**: [KnowledgeFSSpaceTagListResponse](#knowledgefsspacetaglistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 50 |
|
|
| source | query | | No | string, <br>**Available values:** "agent", "mcp", "retrieval_test", "service_api", "workflow" |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base traces | **application/json**: [KnowledgeFSTraceListResponse](#knowledgefstracelistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| trace_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base answer trace | **application/json**: [KnowledgeFSAnswerTraceResponse](#knowledgefsanswertraceresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/conflicts
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 100 |
|
|
| control_space_id | path | | Yes | string |
|
|
| trace_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base trace conflicts | **application/json**: [KnowledgeFSTraceEntryListResponse](#knowledgefstraceentrylistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/evidence
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 100 |
|
|
| control_space_id | path | | Yes | string |
|
|
| trace_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base trace evidence view | **application/json**: [KnowledgeFSTraceEntryListResponse](#knowledgefstraceentrylistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/missing
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| cursor | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 100 |
|
|
| control_space_id | path | | Yes | string |
|
|
| trace_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base trace missing evidence | **application/json**: [KnowledgeFSTraceEntryListResponse](#knowledgefstraceentrylistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/upload-sessions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| Idempotency-Key | header | Stable key used to make the mutation safe to retry | Yes | string |
|
|
| control_space_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSUploadSessionCreatePayload](#knowledgefsuploadsessioncreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base upload session created | **application/json**: [KnowledgeFSUploadSessionCreateResponse](#knowledgefsuploadsessioncreateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/upload-sessions/{upload_session_id}/abort
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| upload_session_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSUploadSessionAbortPayload](#knowledgefsuploadsessionabortpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base upload session aborted | **application/json**: [KnowledgeFSUploadSessionMutationResponse](#knowledgefsuploadsessionmutationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/upload-sessions/{upload_session_id}/complete
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| upload_session_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSUploadSessionCompletePayload](#knowledgefsuploadsessioncompletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base upload session completed | **application/json**: [KnowledgeFSUploadSessionMutationResponse](#knowledgefsuploadsessionmutationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/upload-sessions/{upload_session_id}/parts/{part_number}/presign
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| part_number | path | | Yes | integer |
|
|
| upload_session_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSUploadPartPresignPayload](#knowledgefsuploadpartpresignpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base upload part URL created | **application/json**: [KnowledgeFSPresignedUploadResponse](#knowledgefspresigneduploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/spaces/{control_space_id}/upload-sessions/{upload_session_id}/small-file
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| control_space_id | path | | Yes | string |
|
|
| upload_session_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base small-file fallback completed | **application/json**: [KnowledgeFSSmallFileUploadResponse](#knowledgefssmallfileuploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsResourceNotFoundError](#knowledgefsresourcenotfounderror)<br>[KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [KnowledgeFsConflictError](#knowledgefsconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[KnowledgeFsUpstreamUnavailableError](#knowledgefsupstreamunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/tasks/{task_id}/stream-capability
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [KnowledgeFSStreamCapabilityPayload](#knowledgefsstreamcapabilitypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Knowledge Base task stream capability | **application/json**: [KnowledgeFSStreamCapabilityResponse](#knowledgefsstreamcapabilityresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [KnowledgeFsInvalidRequestError](#knowledgefsinvalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [KnowledgeFsAccessDeniedError](#knowledgefsaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [KnowledgeFsSpaceNotFoundError](#knowledgefsspacenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /knowledge-fs/uploads
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Agent Knowledge Base document bytes staged in the current workspace | **application/json**: [KnowledgeFSStagedUploadResponse](#knowledgefsstageduploadresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [KnowledgeFsRequestTooLargeError](#knowledgefsrequesttoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Unprocessable Entity | **application/json**: [KnowledgeFsRequestRejectedError](#knowledgefsrequestrejectederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /knowledge-fs/uploads/{upload_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| upload_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Agent Knowledge Base staged upload discarded | |
|
|
| 503 | Service Unavailable | **application/json**: [KnowledgeFsOperationUnavailableError](#knowledgefsoperationunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /login
|
|
**Authenticate user and login**
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [LoginPayload](#loginpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultOptionalDataResponse](#simpleresultoptionaldataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountBannedError](#accountbannederror)<br>[AccountInFreezeError](#accountinfreezeerror)<br>[AccountNotFoundError](#accountnotfounderror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[InvalidAccountPasswordError](#invalidaccountpassworderror)<br>[InvalidEmailError](#invalidemailerror)<br>[LimitExceededError](#limitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 401 | Unauthorized | **application/json**: [AuthenticationFailedError](#authenticationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailCodeLoginLimitError](#emailcodeloginlimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /logout
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /mcp/oauth/callback
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| code | query | | Yes | string |
|
|
| state | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to OAuth callback page | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /notification
|
|
Return the active in-product notification for the current user in the requested language (defaults to English when omitted). Unavailable translations fall back to English, then the first available content. The notification is NOT marked as seen here; call POST /notification/dismiss when the user explicitly closes the modal.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Notification language | No | string, <br>**Default:** en-US |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success — inspect should_show to decide whether to render the modal | **application/json**: [NotificationResponse](#notificationresponse)<br> |
|
|
| 401 | Unauthorized | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /notification/dismiss
|
|
Mark a notification as dismissed for the current user.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DismissNotificationPayload](#dismissnotificationpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 401 | Unauthorized | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /notion/pages/{page_id}/{page_type}/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| credential_id | query | Credential ID | Yes | string |
|
|
| page_id | path | | Yes | string (uuid) |
|
|
| page_type | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TextContentResponse](#textcontentresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /notion/pre-import/pages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| credential_id | query | Credential ID | Yes | string |
|
|
| dataset_id | query | Dataset ID | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [NotionIntegrateInfoListResponse](#notionintegrateinfolistresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [DatasetAccessDeniedError](#datasetaccessdeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/authorize/{provider}
|
|
Handle OAuth callback and complete login process
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | OAuth provider name (github/google) | Yes | string |
|
|
| code | query | Authorization code from OAuth provider | Yes | string |
|
|
| state | query | OAuth state parameter | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to console with access token | **application/json**: [RedirectResponse](#redirectresponse)<br> |
|
|
| 400 | OAuth process failed | **application/json**: [OAuthErrorResponse](#oautherrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/data-source/binding/{provider}
|
|
Bind OAuth data source with authorization code
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | Data source provider name (notion) | Yes | string |
|
|
| code | query | Authorization code from OAuth provider | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Data source binding success | **application/json**: [OAuthDataSourceBindingResponse](#oauthdatasourcebindingresponse)<br> |
|
|
| 400 | Invalid provider or code | **application/json**: [ErrorMessageResponse](#errormessageresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/data-source/callback/{provider}
|
|
Handle OAuth callback from data source provider
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | Data source provider name (notion) | Yes | string |
|
|
| code | query | Authorization code from OAuth provider | No | string |
|
|
| error | query | Error message from OAuth provider | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to console with result | **application/json**: [RedirectResponse](#redirectresponse)<br> |
|
|
| 400 | Invalid provider | **application/json**: [ErrorMessageResponse](#errormessageresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/data-source/{provider}
|
|
Get OAuth authorization URL for data source provider
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | Data source provider name (notion) | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Authorization URL or internal setup success | **application/json**: [OAuthDataSourceResponse](#oauthdatasourceresponse)<br> |
|
|
| 400 | Invalid provider | **application/json**: [ErrorMessageResponse](#errormessageresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/data-source/{provider}/{binding_id}/sync
|
|
Sync data from OAuth data source
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| binding_id | path | Data source binding ID | Yes | string (uuid) |
|
|
| provider | path | Data source provider name (notion) | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Data source sync success | **application/json**: [OAuthDataSourceSyncResponse](#oauthdatasourcesyncresponse)<br> |
|
|
| 400 | Invalid provider or sync failed | **application/json**: [ErrorMessageResponse](#errormessageresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/login/{provider}
|
|
Initiate OAuth login process
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | OAuth provider name (github/google) | Yes | string |
|
|
| invite_token | query | Optional invitation token | No | string |
|
|
| language | query | Preferred interface language | No | string |
|
|
| redirect_url | query | Relative page to resume after login | No | string |
|
|
| timezone | query | Preferred timezone | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to OAuth authorization URL | **application/json**: [RedirectResponse](#redirectresponse)<br> |
|
|
| 400 | Invalid provider | **application/json**: [OAuthErrorResponse](#oautherrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/plugin/{provider_id}/datasource/callback
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| code | query | Authorization code from OAuth provider | No | string |
|
|
| context_id | query | OAuth proxy context ID | No | string |
|
|
| error | query | Error message from OAuth provider | No | string |
|
|
| state | query | OAuth state parameter | No | string |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to OAuth callback page | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/plugin/{provider_id}/datasource/get-authorization-url
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| credential_id | query | Credential ID to reauthorize | No | string |
|
|
| visibility | query | Visibility for the credential to be created. Accepts 'only_me' or 'all_team_members'; any other value falls back to 'only_me'. Ignored on reauthorization (credential_id set). | No | string |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource OAuth authorization URL generated successfully | **application/json**: [PluginOAuthAuthorizationUrlResponse](#pluginoauthauthorizationurlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/plugin/{provider}/tool/authorization-url
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| visibility | query | Visibility for the OAuth credential. Defaults to 'only_me'. | No | string, <br>**Available values:** "all_team_members", "only_me" |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Tool OAuth authorization URL generated successfully | **application/json**: [PluginOAuthAuthorizationUrlResponse](#pluginoauthauthorizationurlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/plugin/{provider}/tool/callback
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to OAuth callback page | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /oauth/plugin/{provider}/trigger/callback
|
|
**Handle OAuth callback for trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to OAuth callback page | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /oauth/provider
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OAuthProviderRequest](#oauthproviderrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [OAuthProviderAppResponse](#oauthproviderappresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /oauth/provider/account
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OAuthClientPayload](#oauthclientpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [OAuthProviderAccountResponse](#oauthprovideraccountresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /oauth/provider/authorize
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OAuthClientPayload](#oauthclientpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [OAuthProviderAuthorizeResponse](#oauthproviderauthorizeresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /oauth/provider/token
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OAuthTokenRequest](#oauthtokenrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [OAuthProviderTokenResponse](#oauthprovidertokenresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /onboarding/step-by-step-tour/state
|
|
Get account-level Step-by-step Tour state
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [StepByStepTourStateResponse](#stepbysteptourstateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /onboarding/step-by-step-tour/state
|
|
Update account-level Step-by-step Tour state
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [StepByStepTourStatePatchPayload](#stepbysteptourstatepatchpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [StepByStepTourStateResponse](#stepbysteptourstateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /rag/pipeline/customized/templates/{template_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| template_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Pipeline template deleted | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /rag/pipeline/customized/templates/{template_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| template_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Pipeline template updated | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipeline/customized/templates/{template_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| template_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleDataResponse](#simpledataresponse)<br> |
|
|
| 404 | Customized pipeline template not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipeline/dataset
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RagPipelineDatasetImportPayload](#ragpipelinedatasetimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | RAG pipeline dataset import started | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DatasetNameDuplicateError](#datasetnameduplicateerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipeline/empty-dataset
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | RAG pipeline dataset created | **application/json**: [DatasetDetailResponse](#datasetdetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipeline/templates
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Template language | No | string, <br>**Default:** en-US |
|
|
| type | query | Template source: built-in or customized | No | string, <br>**Default:** built-in |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Pipeline templates | **application/json**: [PipelineTemplateListResponse](#pipelinetemplatelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipeline/templates/{template_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| type | query | Template source: built-in or customized | No | string, <br>**Default:** built-in |
|
|
| template_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Pipeline template | **application/json**: [PipelineTemplateDetailResponse](#pipelinetemplatedetailresponse)<br> |
|
|
| 404 | Pipeline template not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/datasource-plugins
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineDatasourceListResponse](#ragpipelinedatasourcelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/imports
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RagPipelineImportPayload](#ragpipelineimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Import completed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
|
|
| 202 | Import pending confirmation | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
|
|
| 400 | Import failed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/imports/{import_id}/confirm
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| import_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Import confirmed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br> |
|
|
| 400 | Import failed | **application/json**: [RagPipelineImportResponse](#ragpipelineimportresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/imports/{pipeline_id}/check-dependencies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dependencies checked | **application/json**: [RagPipelineImportCheckDependenciesResponse](#ragpipelineimportcheckdependenciesresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/recommended-plugins
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| type | query | | No | string, <br>**Default:** all |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineRecommendedPluginsResponse](#ragpipelinerecommendedpluginsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/transform/datasets/{dataset_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineTransformResponse](#ragpipelinetransformresponse)<br> |
|
|
| 404 | Dataset or pipeline not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/customized/publish
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CustomizedPipelineTemplatePayload](#customizedpipelinetemplatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Pipeline template published | |
|
|
| 404 | Pipeline, workflow, or dataset not found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/exports
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| include_secret | query | Whether to include secret values in the exported DSL | No | string, <br>**Default:** false |
|
|
| pipeline_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Pipeline exported | **application/json**: [SimpleDataResponse](#simpledataresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflow-runs
|
|
**Get workflow run list**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| last_id | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow runs retrieved successfully | **application/json**: [WorkflowRunPaginationResponse](#workflowrunpaginationresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflow-runs/tasks/{task_id}/stop
|
|
**Stop workflow task**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}
|
|
**Get workflow run detail**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| run_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run detail retrieved successfully | **application/json**: [WorkflowRunDetailResponse](#workflowrundetailresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflow-runs/{run_id}/node-executions
|
|
**Get workflow run node execution list**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| run_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node executions retrieved successfully | **application/json**: [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows
|
|
**Get published workflows**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| limit | query | | No | integer, <br>**Default:** 10 |
|
|
| named_only | query | | No | boolean |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
| user_id | query | | No | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published workflows retrieved successfully | **application/json**: [WorkflowPaginationResponse](#workflowpaginationresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs
|
|
**Get default block config**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default block configs retrieved successfully | **application/json**: [DefaultBlockConfigsResponse](#defaultblockconfigsresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/default-workflow-block-configs/{block_type}
|
|
**Get default block config**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| q | query | | No | string |
|
|
| block_type | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default block config retrieved successfully | **application/json**: [DefaultBlockConfigResponse](#defaultblockconfigresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft
|
|
**Get draft rag pipeline's workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow retrieved successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
|
|
| 404 | Draft workflow not found | **application/json**: [DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft
|
|
**Sync draft workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DraftWorkflowSyncPayload](#draftworkflowsyncpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineWorkflowSyncResponse](#ragpipelineworkflowsyncresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DraftWorkflowNotSyncError](#draftworkflownotsyncerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/datasource/nodes/{node_id}/run
|
|
**Run rag pipeline datasource**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceNodeRunPayload](#datasourcenoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineOpaqueResponse](#ragpipelineopaqueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/datasource/variables-inspect
|
|
**Set datasource variables**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceVariablesPayload](#datasourcevariablespayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Datasource variables set successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/environment-variables
|
|
**Get draft workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Environment variables retrieved successfully | **application/json**: [EnvironmentVariableListResponse](#environmentvariablelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/iteration/nodes/{node_id}/run
|
|
**Run draft workflow iteration node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NodeRunPayload](#noderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineOpaqueResponse](#ragpipelineopaqueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/loop/nodes/{node_id}/run
|
|
**Run draft workflow loop node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NodeRunPayload](#noderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineOpaqueResponse](#ragpipelineopaqueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/last-run
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node last run retrieved successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/run
|
|
**Run draft workflow node**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NodeRunRequiredPayload](#noderunrequiredpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node run started successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Node variables deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/nodes/{node_id}/variables
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/pre-processing/parameters
|
|
**Get first step parameters of rag pipeline**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | query | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineStepParametersResponse](#ragpipelinestepparametersresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/processing/parameters
|
|
**Get second step parameters of rag pipeline**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | query | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineStepParametersResponse](#ragpipelinestepparametersresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/draft/run
|
|
**Run draft workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RagPipelineDraftWorkflowRunPayload](#ragpipelinedraftworkflowrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineOpaqueResponse](#ragpipelineopaqueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/system-variables
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | System variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/variables
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Workflow variables deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/variables
|
|
**Get draft workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow variables retrieved successfully | **application/json**: [WorkflowDraftVariableListWithoutValueResponse](#workflowdraftvariablelistwithoutvalueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Variable deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable retrieved successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowDraftVariablePatchPayload](#workflowdraftvariablepatchpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable updated successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /rag/pipelines/{pipeline_id}/workflows/draft/variables/{variable_id}/reset
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable reset successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 204 | Variable reset (no content) | |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/publish
|
|
**Get published pipeline**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published workflow retrieved successfully, or null if not exist | **application/json**: [RagPipelinePublishedWorkflowResponse](#ragpipelinepublishedworkflowresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/publish
|
|
**Publish workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineWorkflowPublishResponse](#ragpipelineworkflowpublishresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/preview
|
|
**Run datasource content preview**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceContentPreviewPayload](#datasourcecontentpreviewpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/published/datasource/nodes/{node_id}/run
|
|
**Run rag pipeline datasource**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [DatasourceNodeRunPayload](#datasourcenoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineOpaqueResponse](#ragpipelineopaqueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/published/pre-processing/parameters
|
|
**Get first step parameters of rag pipeline**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | query | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineStepParametersResponse](#ragpipelinestepparametersresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /rag/pipelines/{pipeline_id}/workflows/published/processing/parameters
|
|
**Get second step parameters of rag pipeline**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | query | | Yes | string |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineStepParametersResponse](#ragpipelinestepparametersresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/published/run
|
|
**Run published workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [PublishedWorkflowRunPayload](#publishedworkflowrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelinePublishedRunResponse](#ragpipelinepublishedrunresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}
|
|
**Delete a published workflow version that is not currently active on the pipeline**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| workflow_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Workflow deleted successfully | |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}
|
|
**Update workflow attributes**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| workflow_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowUpdatePayload](#workflowupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow updated successfully | **application/json**: [WorkflowResponse](#workflowresponse)<br> |
|
|
| 400 | No valid fields to update | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Permission denied | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Workflow not found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rag/pipelines/{pipeline_id}/workflows/{workflow_id}/restore
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| pipeline_id | path | | Yes | string (uuid) |
|
|
| workflow_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RagPipelineWorkflowSyncResponse](#ragpipelineworkflowsyncresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [PipelineNotFoundError](#pipelinenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /refresh-token
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 401 | Unauthorized | **application/json**: [SimpleResultMessageResponse](#simpleresultmessageresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /remote-files/upload
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RemoteFileUploadPayload](#remotefileuploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | File uploaded successfully | **application/json**: [FileWithSignedUrl](#filewithsignedurl)<br> |
|
|
| 400 | Invalid, blocked, or inaccessible remote file URL | **application/json**: [FileExtensionBlockedError](#fileextensionblockederror)<br>[RemoteFileAccessDeniedError](#remotefileaccessdeniederror)<br>[RemoteFileInvalidUrlError](#remotefileinvalidurlerror)<br>[RemoteFileUrlBlockedError](#remotefileurlblockederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Remote file not found | **application/json**: [RemoteFileNotFoundError](#remotefilenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | File too large | **application/json**: [FileTooLargeError](#filetoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported file type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Request payload validation failed | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Remote file unavailable or returned an invalid response | **application/json**: [RemoteFileInvalidResponseError](#remotefileinvalidresponseerror)<br>[RemoteFileUnavailableError](#remotefileunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /remote-files/{url}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| url | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RemoteFileInfo](#remotefileinfo)<br> |
|
|
| 400 | Invalid, blocked, or inaccessible remote file URL | **application/json**: [RemoteFileAccessDeniedError](#remotefileaccessdeniederror)<br>[RemoteFileInvalidUrlError](#remotefileinvalidurlerror)<br>[RemoteFileUrlBlockedError](#remotefileurlblockederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Remote file not found | **application/json**: [RemoteFileNotFoundError](#remotefilenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal server error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Remote file unavailable or returned an invalid response | **application/json**: [RemoteFileInvalidResponseError](#remotefileinvalidresponseerror)<br>[RemoteFileUnavailableError](#remotefileunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /reset-password
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailPayload](#emailpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AccountBannedError](#accountbannederror)<br>[AccountInFreezeError](#accountinfreezeerror)<br>[EmailDomainSuspendedError](#emaildomainsuspendederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [PasswordResetRateLimitExceededError](#passwordresetratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /resource-access-tokens
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Resource access tokens | **application/json**: [ResourceAccessTokenListResponse](#resourceaccesstokenlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /resource-access-tokens
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ResourceAccessTokenCreatePayload](#resourceaccesstokencreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Resource access token created | **application/json**: [ResourceAccessTokenCreateResponse](#resourceaccesstokencreateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /resource-access-tokens/{token_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| token_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ResourceAccessTokenUpdatePayload](#resourceaccesstokenupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Resource access token updated | **application/json**: [ResourceAccessTokenListResponse](#resourceaccesstokenlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /resource-access-tokens/{token_id}/relations/{relation_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| relation_id | path | | Yes | string (uuid) |
|
|
| token_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Resource access token relation deleted | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rule-code-generate
|
|
Generate code rules using LLM
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RuleCodeGeneratePayload](#rulecodegeneratepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Code rules generated successfully | **application/json**: [GeneratorResponse](#generatorresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rule-generate
|
|
Generate rule configuration using LLM
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RuleGeneratePayload](#rulegeneratepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Rule configuration generated successfully | **application/json**: [RuleGenerateResponse](#rulegenerateresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /rule-structured-output-generate
|
|
Generate structured output rules using LLM
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RuleStructuredOutputPayload](#rulestructuredoutputpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Structured output generated successfully | **application/json**: [StructuredOutputGenerateResponse](#structuredoutputgenerateresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflow-runs
|
|
**List workflow runs for snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| last_id | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow runs retrieved successfully | **application/json**: [WorkflowRunPaginationResponse](#workflowrunpaginationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflow-runs/tasks/{task_id}/stop
|
|
**Stop a running or paused task belonging to this snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Task stopped successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflow-runs/{run_id}
|
|
**Get workflow run detail for snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| run_id | path | | Yes | string (uuid) |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow run detail retrieved successfully | **application/json**: [WorkflowRunDetailResponse](#workflowrundetailresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflow-runs/{run_id}/node-executions
|
|
**List node executions for a workflow run**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| run_id | path | | Yes | string (uuid) |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node executions retrieved successfully | **application/json**: [WorkflowRunNodeExecutionListResponse](#workflowrunnodeexecutionlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows
|
|
**Get all published workflow versions for snippet**
|
|
|
|
Get all published workflows for a snippet
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
| limit | query | | No | integer, <br>**Default:** 10 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published workflows retrieved successfully | **application/json**: [SnippetWorkflowPaginationResponse](#snippetworkflowpaginationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/default-workflow-block-configs
|
|
**Get default block configurations for snippet workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default block configs retrieved successfully | **application/json**: [DefaultBlockConfigsResponse](#defaultblockconfigsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft
|
|
**Get draft workflow for snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow retrieved successfully | **application/json**: [SnippetWorkflowResponse](#snippetworkflowresponse)<br> |
|
|
| 404 | Snippet or draft workflow not found | **application/json**: [DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft
|
|
**Sync draft workflow for snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetDraftSyncPayload](#snippetdraftsyncpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow synced successfully | **application/json**: [WorkflowRestoreResponse](#workflowrestoreresponse)<br> |
|
|
| 400 | Hash mismatch | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [DraftWorkflowNotSyncError](#draftworkflownotsyncerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/config
|
|
**Get snippet draft workflow configuration limits**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft config retrieved successfully | **application/json**: [SnippetDraftConfigResponse](#snippetdraftconfigresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/conversation-variables
|
|
Conversation variables are not used in snippet workflows; returns an empty list for API parity
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Conversation variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/environment-variables
|
|
Get environment variables from snippet draft workflow graph
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Environment variables retrieved successfully | **application/json**: [EnvironmentVariableListResponse](#environmentvariablelistresponse)<br> |
|
|
| 404 | Draft workflow not found | **application/json**: [DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/iteration/nodes/{node_id}/run
|
|
**Run a draft workflow iteration node for snippet**
|
|
|
|
Run draft workflow iteration node for snippet
|
|
Iteration nodes execute their internal sub-graph multiple times over an input list.
|
|
Returns an SSE event stream with iteration progress and results.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | Node ID | Yes | string |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetIterationNodeRunPayload](#snippetiterationnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Iteration node run started successfully (SSE stream) | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 404 | Snippet or draft workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/loop/nodes/{node_id}/run
|
|
**Run a draft workflow loop node for snippet**
|
|
|
|
Run draft workflow loop node for snippet
|
|
Loop nodes execute their internal sub-graph repeatedly until a condition is met.
|
|
Returns an SSE event stream with loop progress and results.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | Node ID | Yes | string |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetLoopNodeRunPayload](#snippetloopnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Loop node run started successfully (SSE stream) | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 404 | Snippet or draft workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snapshot_id | query | | No | string |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet agent composer state | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet agent composer saved | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/candidates
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet agent composer candidates | **application/json**: [AgentComposerCandidatesResponse](#agentcomposercandidatesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/copy-from-roster
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowComposerCopyFromRosterPayload](#workflowcomposercopyfromrosterpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Roster agent copied into snippet | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentVersionConflictError](#agentversionconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/impact
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet agent composer impact | **application/json**: [AgentComposerImpactResponse](#agentcomposerimpactresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/save-to-roster
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet agent saved to roster | **application/json**: [WorkflowAgentComposerResponse](#workflowagentcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentNotFoundError](#agentnotfounderror)<br>[AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [AgentNameConflictError](#agentnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/agent-composer/validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ComposerSavePayload](#composersavepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet agent composer validation | **application/json**: [AgentComposerValidateResponse](#agentcomposervalidateresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AgentSoulLockedError](#agentsoullockederror)<br>[InvalidComposerConfigError](#invalidcomposerconfigerror)<br>[PlaintextSecretNotAllowedError](#plaintextsecretnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/last-run
|
|
**Get the last run result for a specific node in snippet draft workflow**
|
|
|
|
Get last run result for a node in snippet draft workflow
|
|
Returns the most recent execution record for the given node,
|
|
including status, inputs, outputs, and timing information.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | Node ID | Yes | string |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node last run retrieved successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 404 | Snippet, draft workflow, or node last run not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/run
|
|
**Run a single node in snippet draft workflow**
|
|
|
|
Run a single node in snippet draft workflow (single-step debugging)
|
|
Executes a specific node with provided inputs for single-step debugging.
|
|
Returns the node execution result including status, outputs, and timing.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | Node ID | Yes | string |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetDraftNodeRunPayload](#snippetdraftnoderunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node run completed successfully | **application/json**: [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse)<br> |
|
|
| 404 | Snippet or draft workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/variables
|
|
Delete all variables for a specific node (snippet draft workflow)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Node variables deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/nodes/{node_id}/variables
|
|
Get variables for a specific node (snippet draft workflow)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| node_id | path | | Yes | string |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Node variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/draft/run
|
|
**Run draft workflow for snippet**
|
|
|
|
Executes the snippet's draft workflow with the provided inputs
|
|
and returns an SSE event stream with execution progress and results.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetDraftRunPayload](#snippetdraftrunpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft workflow run started successfully (SSE stream) | **application/json**: [GeneratedAppResponse](#generatedappresponse)<br> |
|
|
| 404 | Snippet or draft workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/system-variables
|
|
System variables are not used in snippet workflows; returns an empty list for API parity
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | System variables retrieved successfully | **application/json**: [WorkflowDraftVariableListResponse](#workflowdraftvariablelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /snippets/{snippet_id}/workflows/draft/variables
|
|
Delete all draft workflow variables for the current user (snippet scope)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Workflow variables deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/variables
|
|
List draft workflow variables without values (paginated, snippet scope)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| limit | query | Items per page | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow variables retrieved successfully | **application/json**: [WorkflowDraftVariableListWithoutValueResponse](#workflowdraftvariablelistwithoutvalueresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [DraftWorkflowNotExistError](#draftworkflownotexisterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
|
|
Delete a draft workflow variable (snippet scope)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Variable deleted successfully | |
|
|
| 404 | Variable not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
|
|
Get a specific draft workflow variable (snippet scope)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable retrieved successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 404 | Variable not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}
|
|
Update a draft workflow variable (snippet scope)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowDraftVariableUpdatePayload](#workflowdraftvariableupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable updated successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 404 | Variable not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /snippets/{snippet_id}/workflows/draft/variables/{variable_id}/reset
|
|
Reset a draft workflow variable to its default value (snippet scope)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
| variable_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Variable reset successfully | **application/json**: [WorkflowDraftVariableResponse](#workflowdraftvariableresponse)<br> |
|
|
| 204 | Variable reset (no content) | |
|
|
| 404 | Variable not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /snippets/{snippet_id}/workflows/publish
|
|
**Get published workflow for snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published workflow retrieved successfully | **application/json**: [SnippetWorkflowResponse](#snippetworkflowresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/publish
|
|
**Publish snippet workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetPublishWorkflowPayload](#snippetpublishworkflowpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow published successfully | **application/json**: [WorkflowPublishResponse](#workflowpublishresponse)<br> |
|
|
| 400 | No draft workflow found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /snippets/{snippet_id}/workflows/{workflow_id}
|
|
**Delete a published snippet workflow version**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
| workflow_id | path | Workflow ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Workflow deleted successfully | |
|
|
| 400 | Workflow is in use | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /snippets/{snippet_id}/workflows/{workflow_id}
|
|
**Update a published snippet workflow version's display metadata**
|
|
|
|
Update published snippet workflow attributes
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
| workflow_id | path | Workflow ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowUpdatePayload](#workflowupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow updated successfully | **application/json**: [SnippetWorkflowResponse](#snippetworkflowresponse)<br> |
|
|
| 400 | No valid fields to update | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /snippets/{snippet_id}/workflows/{workflow_id}/restore
|
|
**Restore a published snippet workflow version into the draft workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
| workflow_id | path | Published workflow ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow restored successfully | **application/json**: [WorkflowRestoreResponse](#workflowrestoreresponse)<br> |
|
|
| 400 | Source workflow must be published | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Workflow not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /spec/schema-definitions
|
|
**Get system JSON Schema definitions specification**
|
|
|
|
Used for frontend component type mapping
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SchemaDefinitionsResponse](#schemadefinitionsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /system-features
|
|
**Get the non-sensitive bootstrap snapshot exposed before authentication**
|
|
|
|
Get the non-sensitive bootstrap snapshot exposed before Console or Web authentication. This is not a general feature registry.
|
|
Authentication configuration must be available before the authentication flow can be selected.
|
|
Authenticated license detail is served separately by SystemFeatureLicenseApi.
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SystemFeatureModel](#systemfeaturemodel)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /system-features/license
|
|
**Get full license detail (status, expiry, workspace/seat usage)**
|
|
|
|
Get license status and usage detail
|
|
Authenticated counterpart to the license *status* exposed on the public
|
|
system-features endpoint.
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [LicenseModel](#licensemodel)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /tag-bindings
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TagBindingPayload](#tagbindingpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /tag-bindings/remove
|
|
Remove one or more tag bindings from a target.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TagBindingRemovePayload](#tagbindingremovepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /tags
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | Search keyword | No | string |
|
|
| type | query | Tag type filter | Yes | string, <br>**Available values:** "app", "knowledge", "skill", "snippet" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TagListResponse](#taglistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /tags
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TagBasePayload](#tagbasepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TagResponse](#tagresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /tags/{tag_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| tag_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Tag deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /tags/{tag_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| tag_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TagUpdateRequestPayload](#tagupdaterequestpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TagResponse](#tagresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}
|
|
**Get app detail using the viewer's workspace for tool configuration**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TrialAppDetailResponse](#trialappdetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AppSiteUnavailableError](#appsiteunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent-composer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published Agent configuration | **application/json**: [AgentAppComposerResponse](#agentappcomposerresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigFileListResponse](#agentconfigfilelistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/files/{name}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/files/{name}/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigFilePreviewResponse](#agentconfigfilepreviewresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/skills
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigSkillListResponse](#agentconfigskilllistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/skills/{name}/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/skills/{name}/files/content
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| path | query | Normalized member path inside the published Skill package | Yes | string |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/octet-stream**: binary<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/skills/{name}/files/download
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| path | query | Normalized member path inside the published Skill package | Yes | string |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigDownloadResponse](#agentconfigdownloadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/skills/{name}/files/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| path | query | Normalized member path inside the published Skill package | Yes | string |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigSkillFilePreviewResponse](#agentconfigskillfilepreviewresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/agent/config/skills/{name}/inspect
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| version_id | query | Must match the current published template snapshot | No | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| name | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published template resource | **application/json**: [AgentConfigSkillInspectResponse](#agentconfigskillinspectresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/audio-to-text
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AudioTranscriptResponse](#audiotranscriptresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NoAudioUploadedError](#noaudiouploadederror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportSpeechToTextError](#providernotsupportspeechtotexterror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[SpeechToTextDisabledError](#speechtotextdisablederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [AudioTooLargeError](#audiotoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedAudioTypeError](#unsupportedaudiotypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/chat-messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ChatRequest](#chatrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotChatAppError](#notchatapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/chat-messages/{task_id}/stop
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotChatAppError](#notchatapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/completion-messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CompletionRequest](#completionrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotCompletionAppError](#notcompletionapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/datasets
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| ids | query | Dataset IDs | No | [ string ] |
|
|
| limit | query | Number of items per page | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TrialDatasetListResponse](#trialdatasetlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NeedAddIdsError](#needaddidserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/export
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| format | query | Export format; defaults to ifpkg | No | string, <br>**Available values:** "ifpkg", "yaml", <br>**Default:** ifpkg |
|
|
| version_id | query | Current published template snapshot ID | Yes | string (uuid) |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Published Agent template export | **application/json**: [AppExportResponse](#appexportresponse)<br>**application/zip**: binary<br> |
|
|
| 404 | Published template unavailable | **application/json**: [RecommendedAppNotFoundError](#recommendedappnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [RosterAgentPackageExportFailedError](#rosteragentpackageexportfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/files/upload
|
|
**Upload a file into the tenant that owns the trial app**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary, **"source"**: string, <br>**Available values:** "datasets" }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | File uploaded successfully | **application/json**: [FileResponse](#fileresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [FileExtensionBlockedError](#fileextensionblockederror)<br>[FilenameNotExistsError](#filenamenotexistserror)<br>[NoFileUploadedError](#nofileuploadederror)<br>[TooManyFilesError](#toomanyfileserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [FileTooLargeError](#filetoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/messages/{message_id}/suggested-questions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| message_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuggestedQuestionsResponse](#suggestedquestionsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotChatAppError](#notchatapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AppSuggestedQuestionsAfterAnswerDisabledError](#appsuggestedquestionsafteranswerdisablederror)<br>[TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/parameters
|
|
**Retrieve app parameters**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [Parameters](#parameters)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/remote-files/upload
|
|
**Upload a remote file into the tenant that owns the trial app**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RemoteFileUploadPayload](#remotefileuploadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | File uploaded successfully | **application/json**: [FileWithSignedUrl](#filewithsignedurl)<br> |
|
|
| 400 | Bad Request | **application/json**: [FileExtensionBlockedError](#fileextensionblockederror)<br>[RemoteFileAccessDeniedError](#remotefileaccessdeniederror)<br>[RemoteFileInvalidUrlError](#remotefileinvalidurlerror)<br>[RemoteFileUrlBlockedError](#remotefileurlblockederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [RemoteFileNotFoundError](#remotefilenotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [FileTooLargeError](#filetoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [RemoteFileInvalidResponseError](#remotefileinvalidresponseerror)<br>[RemoteFileUnavailableError](#remotefileunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/site
|
|
**Retrieve app site info**
|
|
|
|
Returns the site configuration for the application including theme, icons, and text.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [Site](#site)<br> |
|
|
| 403 | Forbidden | **application/json**: [AppOwnerUnavailableError](#appownerunavailableerror)<br>[AppSiteUnavailableError](#appsiteunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/text-to-audio
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TextToSpeechRequest](#texttospeechrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **audio/aac**: binary<br>**audio/flac**: binary<br>**audio/mp4**: binary<br>**audio/mpeg**: binary<br>**audio/ogg**: binary<br>**audio/wav**: binary<br>**audio/webm**: binary<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderNotSupportTextToSpeechError](#providernotsupporttexttospeecherror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AgentVersionNotFoundError](#agentversionnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-apps/{app_id}/workflows
|
|
**Get a detached workflow definition after catalog preview admission**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TrialWorkflowResponse](#trialworkflowresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [AppNotFoundError](#appnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/workflows/run
|
|
**Run workflow**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowRunRequest](#workflowrunrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | |
|
|
| 400 | Bad Request | **application/json**: [AppUnavailableError](#appunavailableerror)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[NotWorkflowAppError](#notworkflowapperror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [RateLimitError](#ratelimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /trial-apps/{app_id}/workflows/tasks/{task_id}/stop
|
|
**Stop workflow task**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotWorkflowAppError](#notworkflowapperror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [TrialAppFeatureDisabledError](#trialappfeaturedisablederror)<br>[TrialAppLimitExceededError](#trialapplimitexceedederror)<br>[TrialAppNotAllowedError](#trialappnotallowederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /trial-models
|
|
**Get hosted credit provider configuration for the current workspace**
|
|
|
|
Get hosted credit model provider configuration for the current workspace
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TrialModelsResponse](#trialmodelsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /website/crawl
|
|
Crawl website content
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WebsiteCrawlPayload](#websitecrawlpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Website crawl initiated successfully | **application/json**: [WebsiteCrawlResponse](#websitecrawlresponse)<br> |
|
|
| 400 | Invalid crawl parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [CrawlFailedError](#crawlfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /website/crawl/status/{job_id}
|
|
Get website crawl status
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| job_id | path | Crawl job ID | Yes | string |
|
|
| provider | query | Crawl provider (firecrawl/watercrawl/jinareader) | Yes | string, <br>**Available values:** "firecrawl", "jinareader", "watercrawl" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Crawl status retrieved successfully | **application/json**: [WebsiteCrawlResponse](#websitecrawlresponse)<br> |
|
|
| 400 | Invalid provider | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 500 | Internal Server Error | **application/json**: [CrawlFailedError](#crawlfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workflow-generate
|
|
Generate a Dify workflow graph from natural language
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowGeneratePayload](#workflowgeneratepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow graph generated successfully | **application/json**: [WorkflowGenerateResponse](#workflowgenerateresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [WorkflowGenerateRejectedResponse](#workflowgeneraterejectedresponse)<br>[CompletionRequestError](#completionrequesterror)<br>[ModelCurrentlyNotSupportError](#modelcurrentlynotsupporterror)<br>[ProviderNotInitializeError](#providernotinitializeerror)<br>[ProviderQuotaExceededError](#providerquotaexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workflow-generate/stream
|
|
Stream a Dify workflow graph (plan then result) via SSE
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowGeneratePayload](#workflowgeneratepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Server-Sent Events stream; each data frame matches this plan/result event schema | **application/json**: [WorkflowGenerateStreamEventResponse](#workflowgeneratestreameventresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [WorkflowGenerateRejectedResponse](#workflowgeneraterejectedresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workflow-generate/suggestions
|
|
Suggest example workflow-generator instructions for the tenant
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowInstructionSuggestionsPayload](#workflowinstructionsuggestionspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Suggestions generated successfully | **application/json**: [WorkflowInstructionSuggestionsResponse](#workflowinstructionsuggestionsresponse)<br> |
|
|
| 400 | Invalid request parameters | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workflow-run-archives
|
|
List monthly workflow-run archive metadata for the current workspace
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkflowRunArchiveListResponse](#workflowrunarchivelistresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workflow-run-archives/downloads
|
|
Create or return a temporary workflow-run archive download task
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowRunArchiveDownloadPayload](#workflowrunarchivedownloadpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Download task accepted | **application/json**: [WorkflowRunArchiveDownloadTaskResponse](#workflowrunarchivedownloadtaskresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workflow-run-archives/downloads/{download_id}
|
|
Get a temporary workflow-run archive download task
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| download_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkflowRunArchiveDownloadTaskResponse](#workflowrunarchivedownloadtaskresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workflow-run-archives/downloads/{download_id}/file
|
|
Redirect to a prepared workflow-run archive ZIP file
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| download_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 302 | Redirect to pre-signed archive storage URL | **application/json**: [RedirectResponse](#redirectresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Download task is not ready | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workflow-run-archives/{year}/{month}
|
|
Permanently delete this workspace's monthly archive files and archive index
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| month | path | | Yes | integer |
|
|
| year | path | | Yes | integer |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 202 | Archive deletion accepted | **application/json**: [WorkflowRunArchiveDeletionTaskResponse](#workflowrunarchivedeletiontaskresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workflow/{workflow_run_id}/events
|
|
**Get workflow execution events stream after resume**
|
|
|
|
GET /console/api/workflow/<workflow_run_id>/events
|
|
|
|
Returns Server-Sent Events stream.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| workflow_run_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | SSE event stream | **application/json**: [EventStreamResponse](#eventstreamresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workflow/{workflow_run_id}/pause-details
|
|
**Get workflow pause details**
|
|
|
|
Get workflow pause details
|
|
GET /console/api/workflow/<workflow_run_id>/pause-details
|
|
|
|
Returns information about why and where the workflow is paused.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| workflow_run_id | path | Workflow run ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow pause details retrieved successfully | **application/json**: [WorkflowPauseDetailsResponse](#workflowpausedetailsresponse)<br> |
|
|
| 404 | Workflow run not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [TenantListResponse](#tenantlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/agent-provider/{provider_name}
|
|
Get specific agent provider details
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_name | path | Agent provider name | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AgentProviderResponse](#agentproviderresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/agent-providers
|
|
Get list of available agent providers
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AgentProviderListResponse](#agentproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/agents/{agent_id}/skills
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Skill bindings | **application/json**: [AgentSkillBindingsResponse](#agentskillbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/agents/{agent_id}/skills
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AgentSkillBindingsPayload](#agentskillbindingspayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Agent Skill bindings replaced | **application/json**: [AgentSkillBindingsResponse](#agentskillbindingsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/customized-snippets
|
|
**List customized snippets with pagination and search**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| creators | query | Filter by creator account IDs | No | [ string ] |
|
|
| is_published | query | Filter by published status | No | boolean |
|
|
| keyword | query | | No | string |
|
|
| limit | query | | No | integer, <br>**Default:** 20 |
|
|
| page | query | | No | integer, <br>**Default:** 1 |
|
|
| tag_ids | query | Filter by tag IDs | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippets retrieved successfully | **application/json**: [SnippetPaginationResponse](#snippetpaginationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/customized-snippets
|
|
**Create a new customized snippet**
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CreateSnippetPayload](#createsnippetpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Snippet created successfully | **application/json**: [SnippetResponse](#snippetresponse)<br> |
|
|
| 400 | Invalid request | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/customized-snippets/imports
|
|
**Import snippet from DSL**
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SnippetImportPayload](#snippetimportpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet imported successfully | **application/json**: [SnippetImportResponse](#snippetimportresponse)<br> |
|
|
| 202 | Import pending confirmation | **application/json**: [SnippetImportResponse](#snippetimportresponse)<br> |
|
|
| 400 | Import failed | **application/json**: [SnippetImportResponse](#snippetimportresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/customized-snippets/imports/{import_id}/confirm
|
|
**Confirm a pending snippet import**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| import_id | path | Import ID to confirm | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Import confirmed successfully | **application/json**: [SnippetImportResponse](#snippetimportresponse)<br> |
|
|
| 400 | Import failed | **application/json**: [SnippetImportResponse](#snippetimportresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/customized-snippets/{snippet_id}
|
|
**Delete customized snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Snippet deleted successfully | |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/customized-snippets/{snippet_id}
|
|
**Get customized snippet details**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet retrieved successfully | **application/json**: [SnippetResponse](#snippetresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/customized-snippets/{snippet_id}
|
|
**Update customized snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [UpdateSnippetPayload](#updatesnippetpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet updated successfully | **application/json**: [SnippetResponse](#snippetresponse)<br> |
|
|
| 400 | Invalid request | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/customized-snippets/{snippet_id}/check-dependencies
|
|
**Check dependencies for a snippet**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Dependencies checked successfully | **application/json**: [SnippetDependencyCheckResponse](#snippetdependencycheckresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/customized-snippets/{snippet_id}/export
|
|
**Export snippet as DSL**
|
|
|
|
Export snippet configuration as DSL
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID to export | Yes | string (uuid) |
|
|
| include_secret | query | Whether to include secret variables | No | string, <br>**Default:** false |
|
|
| workflow_id | query | Specific published workflow version to export | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Snippet exported successfully | **application/json**: [TextFileResponse](#textfileresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/customized-snippets/{snippet_id}/use-count/increment
|
|
**Increment snippet use count when it is inserted into a workflow**
|
|
|
|
Increment snippet use count by 1
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| snippet_id | path | Snippet ID | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Use count incremented successfully | **application/json**: [SnippetUseCountResponse](#snippetusecountresponse)<br> |
|
|
| 404 | Snippet not found | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/dataset-operators
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountWithRoleListResponse](#accountwithrolelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/default-model
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| model_type | query | Enum class for model type. | Yes | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default model retrieved successfully | **application/json**: [DefaultModelDataResponse](#defaultmodeldataresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/default-model
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserPostDefault](#parserpostdefault)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/endpoints
|
|
Create a new plugin endpoint
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EndpointCreatePayload](#endpointcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint created successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### ~~[POST] /workspaces/current/endpoints/create~~
|
|
|
|
***DEPRECATED***
|
|
|
|
Deprecated legacy alias for creating a plugin endpoint. Use POST /workspaces/current/endpoints instead.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EndpointCreatePayload](#endpointcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint created successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### ~~[POST] /workspaces/current/endpoints/delete~~
|
|
|
|
***DEPRECATED***
|
|
|
|
Deprecated legacy alias for deleting a plugin endpoint. Use DELETE /workspaces/current/endpoints/{id} instead.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EndpointIdPayload](#endpointidpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint deleted successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/endpoints/disable
|
|
Disable a plugin endpoint
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EndpointIdPayload](#endpointidpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint disabled successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/endpoints/enable
|
|
Enable a plugin endpoint
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EndpointIdPayload](#endpointidpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint enabled successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/endpoints/list
|
|
List plugin endpoints with pagination
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| page | query | | Yes | integer |
|
|
| page_size | query | | Yes | integer |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EndpointListResponse](#endpointlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/endpoints/list/plugin
|
|
List endpoints for a specific plugin
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| page | query | | Yes | integer |
|
|
| page_size | query | | Yes | integer |
|
|
| plugin_id | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EndpointListResponse](#endpointlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### ~~[POST] /workspaces/current/endpoints/update~~
|
|
|
|
***DEPRECATED***
|
|
|
|
Deprecated legacy alias for updating a plugin endpoint. Use PATCH /workspaces/current/endpoints/{id} instead.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [LegacyEndpointUpdatePayload](#legacyendpointupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint updated successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/endpoints/{id}
|
|
Delete a plugin endpoint
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| id | path | Endpoint ID | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint deleted successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/endpoints/{id}
|
|
Update a plugin endpoint
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| id | path | Endpoint ID | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EndpointUpdatePayload](#endpointupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Endpoint updated successfully | **application/json**: [EndpointMutationResponse](#endpointmutationresponse)<br> |
|
|
| 403 | Admin privileges required | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/channel-providers
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListChannelProvidersResponse](#listchannelprovidersresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/channels
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListChannelsResponse](#listchannelsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/email
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailChannelCreatePayload](#emailchannelcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EmailChannelMutationResponse](#emailchannelmutationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/email/test
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailChannelTestPayload](#emailchanneltestpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ChannelTestResponse](#channeltestresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/human-input/v2/channels/email/{channel_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| expected_config_version | query | | Yes | string |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ChannelDeleteResponse](#channeldeleteresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/channels/email/{channel_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EmailChannelDetailResponse](#emailchanneldetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/human-input/v2/channels/email/{channel_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailChannelUpdatePayload](#emailchannelupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [EmailChannelMutationResponse](#emailchannelmutationresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/email/{channel_id}/test
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [EmailChannelUpdatePayload](#emailchannelupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ChannelTestResponse](#channeltestresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/im
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IMChannelCreatePayload](#imchannelcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [IMChannelMutationResponse](#imchannelmutationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/im/test
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IMChannelTestPayload](#imchanneltestpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ChannelTestResponse](#channeltestresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/human-input/v2/channels/im/{channel_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| expected_config_version | query | | Yes | string |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ChannelDeleteResponse](#channeldeleteresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/channels/im/{channel_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [IMChannelDetailResponse](#imchanneldetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/human-input/v2/channels/im/{channel_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IMChannelUpdatePayload](#imchannelupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [IMChannelMutationResponse](#imchannelmutationresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/im/{channel_id}/replacement
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IMChannelReplacementPayload](#imchannelreplacementpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [IMChannelMutationResponse](#imchannelmutationresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/channels/im/{channel_id}/test
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| channel_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [IMChannelUpdatePayload](#imchannelupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ChannelTestResponse](#channeltestresponse)<br> |
|
|
| 400 | The test provider must match the saved IM Channel. | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Configuration conflict | **application/json**: [ChannelConflictResponse](#channelconflictresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/contact-options
|
|
List editor-safe Contact options for static recipient selection. The projection includes effective IM providers and omits binding details and management metadata; unavailable Contacts are omitted.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | Free-text search against selectable contact names. | No | string |
|
|
| limit | query | Maximum number of records returned per page. | No | integer, <br>**Default:** 20 |
|
|
| page | query | 1-based page number. | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListContactOptionsResponse](#listcontactoptionsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/contact-options/batch
|
|
Resolve Contact IDs persisted in workflow recipient configuration. Include effective IM providers for each Contact. Contacts unavailable in the current workspace are omitted.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_ids | query | Contact IDs persisted in workflow recipient configuration. | Yes | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [BatchGetContactOptionsResponse](#batchgetcontactoptionsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/contacts
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| group | query | Optional contact type filter. None means all contacts. | No | string, <br>**Available values:** "external", "platform", "workspace" |
|
|
| keyword | query | Free-text search against contact name or email. | No | string |
|
|
| limit | query | Maximum number of records returned per page. | No | integer, <br>**Default:** 20 |
|
|
| page | query | 1-based page number. | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListContactsResponse](#listcontactsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/contacts/batch
|
|
Admin-only batch lookup for Contact management clients. Workflow editors must use the editor-safe contact-options/batch projection.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_ids | query | List of contact IDs to retrieve. | Yes | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [BatchGetContactsResponse](#batchgetcontactsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/contacts/external
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ExternalContactCreateRequest](#externalcontactcreaterequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ExternalContactCreateResponse](#externalcontactcreateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/human-input/v2/contacts/external/{contact_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ExternalContactUpdateRequest](#externalcontactupdaterequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ExternalContactUpdateResponse](#externalcontactupdateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/contacts/platform
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [AddPlatformContactsRequest](#addplatformcontactsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AddPlatformContactsResponse](#addplatformcontactsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/contacts/remove
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [RemoveContactsRequest](#removecontactsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RemoveContactsResponse](#removecontactsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/contacts/{contact_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [GetContactResponse](#getcontactresponse)<br> |
|
|
| 404 | Contact not found or absent in the current workspace | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/human-input/v2/contacts/{contact_id}/im-bindings
|
|
Delete the current default IM binding for the contact identified by the path. Workspace IM overrides are not modified. This endpoint is not used for resetting workspace IM override. For that purpose, use WorkspaceContactIMOverrideApi.delete instead.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [DeleteIMBindingResponse](#deleteimbindingresponse)<br> |
|
|
| 403 | Centrally managed IM bindings cannot be edited from a workspace | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | IM binding not found | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | IM write unavailable | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/human-input/v2/contacts/{contact_id}/im-bindings
|
|
Set a default IM binding for a contact, atomically replacing any default binding for either the contact or the selected identity. Identical assignments preserve their binding ID; changed assignments receive a new binding ID. This endpoint is not used for creating workspace IM override. For that purpose, use WorkspaceContactIMOverrideApi.put instead.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CreateIMBindingRequest](#createimbindingrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [CreateIMBindingResponse](#createimbindingresponse)<br> |
|
|
| 403 | Centrally managed IM bindings cannot be edited from a workspace | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Contact or IM identity not found | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | IM binding conflict | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | IM write unavailable | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/human-input/v2/contacts/{contact_id}/im-override
|
|
Reset the IM override for a contact. This endpoint is used to clear the IM identity override for a contact in the workspace.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResetContactIMOverrideResponse](#resetcontactimoverrideresponse)<br> |
|
|
| 403 | Workspace overrides require centrally managed IM bindings | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Contact not found | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid binding scope | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | IM write unavailable | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/human-input/v2/contacts/{contact_id}/im-override
|
|
Set or reset the IM override for a contact. This endpoint is used to override the IM identity for a contact in the workspace.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| contact_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SetContactIMOverrideRequest](#setcontactimoverriderequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SetContactIMOverrideResponse](#setcontactimoverrideresponse)<br> |
|
|
| 403 | Workspace overrides require centrally managed IM bindings | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Contact or IM identity not found | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | IM binding conflict | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 422 | Invalid binding scope | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | IM write unavailable | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/im-identities
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | Free-text search against identity display name, email, or provider user ID. | No | string |
|
|
| limit | query | Maximum number of records returned per page. | No | integer, <br>**Default:** 20 |
|
|
| page | query | 1-based page number. | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListIMIdentitiesResponse](#listimidentitiesresponse)<br> |
|
|
| 404 | IM Integration not configured | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/im-sync-runs
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [CreateIMSyncRunResponse](#createimsyncrunresponse)<br> |
|
|
| 404 | IM Integration not configured | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | IM Integration revision changed | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | IM synchronization temporarily unavailable | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/im-sync-runs/latest
|
|
Return the latest IM sync run summary. The UI uses finished_at as the explicit sync time; the response does not include started_by.
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [GetLatestIMSyncRunResponse](#getlatestimsyncrunresponse)<br> |
|
|
| 404 | Latest IM sync run not found | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/im-sync-runs/latest/results
|
|
Return one required result bucket from the latest IM sync run using page and limit pagination. There is no all filter; the response contains page, limit, and total metadata without a run summary.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| limit | query | Maximum number of records returned per page. | No | integer, <br>**Default:** 20 |
|
|
| page | query | 1-based page number. | No | integer, <br>**Default:** 1 |
|
|
| result | query | Required result bucket to paginate from the latest sync run. There is no `all` bucket or unfiltered results mode. | Yes | string, <br>**Available values:** "added", "failed", "not_matched", "removed", "skipped" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListLatestIMSyncRunResultsResponse](#listlatestimsyncrunresultsresponse)<br> |
|
|
| 404 | Latest IM sync run not found | **application/json**: [IMContactSyncErrorResponse](#imcontactsyncerrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/human-input/v2/node-data-migration
|
|
Migrate node data from HITLv1 to HITLv2. A missing legacy version defaults to "1"; any other explicit version is rejected. Every legacy Email recipient becomes onetime_email, while whole_workspace becomes all_workspace_contacts. This side-effect-free endpoint only returns migrated node data; the caller owns applying it to the Draft workflow.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NodeDataMigrationPayload](#nodedatamigrationpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [NodeDataMigrationResponse](#nodedatamigrationresponse)<br> |
|
|
| 400 | Migration failed | **application/json**: [NodeDataMigrationFailureResponse](#nodedatamigrationfailureresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/human-input/v2/organization-candidates
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | Free-text search against candidate name or email. | No | string |
|
|
| limit | query | Maximum number of records returned per page. | No | integer, <br>**Default:** 20 |
|
|
| page | query | 1-based page number. | No | integer, <br>**Default:** 1 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ListOrganizationCandidatesResponse](#listorganizationcandidatesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/members
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccountWithRoleListResponse](#accountwithrolelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/members/invite-email
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MemberInvitePayload](#memberinvitepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Success | **application/json**: [MemberInviteResponse](#memberinviteresponse)<br> |
|
|
| 400 | Invalid email, role, or workspace member limit exceeded | **application/json**: [MemberInviteErrorResponse](#memberinviteerrorresponse)<br>[InvalidRoleError](#invalidroleerror)<br>[LimitExceededError](#limitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/members/owner-transfer-check
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OwnerTransferCheckPayload](#ownertransfercheckpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [VerificationTokenResponse](#verificationtokenresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [EmailCodeError](#emailcodeerror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[NotOwnerError](#notownererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [OwnerTransferLimitError](#ownertransferlimiterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/members/send-owner-transfer-confirm-email
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OwnerTransferEmailPayload](#ownertransferemailpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultDataResponse](#simpleresultdataresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NotOwnerError](#notownererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 429 | Too Many Requests | **application/json**: [EmailSendIpLimitError](#emailsendiplimiterror)<br>[OwnerTransferRateLimitExceededError](#ownertransferratelimitexceedederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/members/{member_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| member_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberActionResponse](#memberactionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [CannotOperateSelfError](#cannotoperateselferror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [MemberNotFoundError](#membernotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/members/{member_id}/owner-transfer
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| member_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [OwnerTransferPayload](#ownertransferpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [CannotTransferOwnerToSelfError](#cannottransferownertoselferror)<br>[InvalidEmailError](#invalidemailerror)<br>[InvalidOrExpiredTokenError](#invalidorexpiredtokenerror)<br>[MemberNotInTenantError](#membernotintenanterror)<br>[NotOwnerError](#notownererror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/members/{member_id}/update-role
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| member_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MemberRoleUpdatePayload](#memberroleupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [CannotOperateSelfError](#cannotoperateselferror)<br>[InvalidRoleError](#invalidroleerror)<br>[RoleAlreadyAssignedError](#rolealreadyassignederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [ForbiddenError](#forbiddenerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [MemberNotFoundError](#membernotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| model_type | query | Enum class for model type. | No | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model providers retrieved successfully | **application/json**: [ModelProviderListResponse](#modelproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers/credits
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model provider credits retrieved successfully | **application/json**: [ModelProviderCreditsResponse](#modelprovidercreditsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers/summary
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model provider summaries retrieved successfully | **application/json**: [ModelProviderSummaryListResponse](#modelprovidersummarylistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### ~~[GET] /workspaces/current/model-providers/{provider}/checkout-url~~
|
|
|
|
***DEPRECATED***
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model provider checkout URL retrieved successfully | **application/json**: [ModelProviderPaymentCheckoutUrlResponse](#modelproviderpaymentcheckouturlresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/model-providers/{provider}/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserCredentialDelete](#parsercredentialdelete)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Credential deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers/{provider}/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| credential_id | query | | No | string |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Provider credentials retrieved successfully | **application/json**: [ProviderCredentialsResponse](#providercredentialsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserCredentialCreate](#parsercredentialcreate)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Credential created successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/model-providers/{provider}/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserCredentialUpdate](#parsercredentialupdate)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Credential updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/credentials/switch
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserCredentialSwitch](#parsercredentialswitch)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/credentials/validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserCredentialValidate](#parsercredentialvalidate)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Provider credentials validated successfully | **application/json**: [ValidationResultResponse](#validationresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/model-providers/{provider}/models
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| model | query | | Yes | string |
|
|
| model_type | query | Enum class for model type. | Yes | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Model deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers/{provider}/models
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Provider models retrieved successfully | **application/json**: [ProviderModelListResponse](#providermodellistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/models
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserPostModels](#parserpostmodels)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/model-providers/{provider}/models/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| credential_id | query | | Yes | string |
|
|
| model | query | | Yes | string |
|
|
| model_type | query | Enum class for model type. | Yes | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 204 | Credential deleted successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers/{provider}/models/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| config_from | query | | No | string |
|
|
| credential_id | query | | No | string |
|
|
| model | query | | Yes | string |
|
|
| model_type | query | Enum class for model type. | Yes | string, <br>**Available values:** "llm", "moderation", "rerank", "speech2text", "text-embedding", "tts" |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model credentials retrieved successfully | **application/json**: [ModelCredentialResponse](#modelcredentialresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/models/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserCreateCredential](#parsercreatecredential)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Model credential created successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/model-providers/{provider}/models/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserUpdateCredential](#parserupdatecredential)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model credential updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/models/credentials/switch
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserSwitch](#parserswitch)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/models/credentials/validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserValidate](#parservalidate)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model credentials validated successfully | **application/json**: [ValidationResultResponse](#validationresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/model-providers/{provider}/models/disable
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserDeleteModels](#parserdeletemodels)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/model-providers/{provider}/models/enable
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserDeleteModels](#parserdeletemodels)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/models/load-balancing-configs/credentials-validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [LoadBalancingCredentialPayload](#loadbalancingcredentialpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Credential validation result | **application/json**: [LoadBalancingCredentialValidateResponse](#loadbalancingcredentialvalidateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/models/load-balancing-configs/{config_id}/credentials-validate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| config_id | path | | Yes | string |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [LoadBalancingCredentialPayload](#loadbalancingcredentialpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Credential validation result | **application/json**: [LoadBalancingCredentialValidateResponse](#loadbalancingcredentialvalidateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/model-providers/{provider}/models/parameter-rules
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| model | query | | Yes | string |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model parameter rules retrieved successfully | **application/json**: [ModelParameterRuleListResponse](#modelparameterrulelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/model-providers/{provider}/preferred-provider-type
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserPreferredProviderType](#parserpreferredprovidertype)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/models/model-types/{model_type}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| model_type | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Available models retrieved successfully | **application/json**: [AvailableModelListResponse](#availablemodellistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/network-access-groups
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workspace network access groups retrieved successfully | **application/json**: [NetworkAccessGroupListResponse](#networkaccessgrouplistresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/network-access-groups
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NetworkAccessGroupCreatePayload](#networkaccessgroupcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Workspace network access group created successfully | **application/json**: [NetworkAccessGroupMutationResponse](#networkaccessgroupmutationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NetworkAccessInvalidInputError](#networkaccessinvalidinputerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [NetworkAccessGroupNameConflictError](#networkaccessgroupnameconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/network-access-groups/current-ip
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trusted current client IP retrieved without requiring an existing network access group | **application/json**: [NetworkAccessGroupCurrentIPResponse](#networkaccessgroupcurrentipresponse)<br> |
|
|
| 403 | The workspace role does not allow network access policy reads | **application/json**: [NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | A trusted current client IP is unavailable | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/network-access-groups/{group_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| expected_version | query | Current group version used for optimistic concurrency | Yes | integer |
|
|
| group_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workspace network access group deleted successfully | **application/json**: [NetworkAccessGroupDeleteResponse](#networkaccessgroupdeleteresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [NetworkAccessGroupNotFoundError](#networkaccessgroupnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [NetworkAccessGroupBoundError](#networkaccessgroupbounderror)<br>[NetworkAccessVersionConflictError](#networkaccessversionconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/network-access-groups/{group_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| group_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workspace network access group retrieved successfully | **application/json**: [NetworkAccessGroupMutationResponse](#networkaccessgroupmutationresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [NetworkAccessGroupNotFoundError](#networkaccessgroupnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/network-access-groups/{group_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| group_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [NetworkAccessGroupUpdatePayload](#networkaccessgroupupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workspace network access group updated successfully | **application/json**: [NetworkAccessGroupMutationResponse](#networkaccessgroupmutationresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [NetworkAccessInvalidInputError](#networkaccessinvalidinputerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[PaidPlanRequiredError](#paidplanrequirederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [NetworkAccessGroupNotFoundError](#networkaccessgroupnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 409 | Conflict | **application/json**: [NetworkAccessGroupNameConflictError](#networkaccessgroupnameconflicterror)<br>[NetworkAccessVersionConflictError](#networkaccessversionconflicterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/network-access-groups/{group_id}/check-current-ip
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| group_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Current client IP checked against the workspace network access group | **application/json**: [NetworkAccessGroupCurrentIPCheckResponse](#networkaccessgroupcurrentipcheckresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [NetworkAccessForbiddenError](#networkaccessforbiddenerror)<br>[NetworkAccessNotEntitledError](#networkaccessnotentitlederror)<br>[NetworkAccessRoleDeniedError](#networkaccessroledeniederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 404 | Not Found | **application/json**: [NetworkAccessGroupNotFoundError](#networkaccessgroupnotfounderror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 502 | Bad Gateway | **application/json**: [BillingOperationFailedError](#billingoperationfailederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 503 | Service Unavailable | **application/json**: [BillingUnavailableError](#billingunavailableerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/permission
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspacePermissionResponse](#workspacepermissionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/asset
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| file_name | query | | Yes | string |
|
|
| plugin_unique_identifier | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/octet-stream**: binary<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/auto-upgrade/change
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserAutoUpgradeChange](#parserautoupgradechange)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginAutoUpgradeChangeResponse](#pluginautoupgradechangeresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/auto-upgrade/exclude
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserExcludePlugin](#parserexcludeplugin)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/auto-upgrade/fetch
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| category | query | | Yes | string, <br>**Available values:** "agent-strategy", "datasource", "extension", "model", "tool", "trigger" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginAutoUpgradeFetchResponse](#pluginautoupgradefetchresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/debugging-key
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginDebuggingKeyResponse](#plugindebuggingkeyresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/fetch-manifest
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| plugin_unique_identifier | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginManifestResponse](#pluginmanifestresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/icon
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| filename | query | | Yes | string |
|
|
| tenant_id | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | `*/*`: binary<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/install/github
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserGithubInstall](#parsergithubinstall)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstallTaskStartResponse](#plugininstalltaskstartresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/install/marketplace
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserPluginIdentifiers](#parserpluginidentifiers)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstallTaskStartResponse](#plugininstalltaskstartresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/install/pkg
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserPluginIdentifiers](#parserpluginidentifiers)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstallTaskStartResponse](#plugininstalltaskstartresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/installed-ids
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| category | query | Plugin category to include | Yes | string, <br>**Available values:** "agent-strategy", "datasource", "extension", "model", "tool", "trigger" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstalledIdsResponse](#plugininstalledidsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/list
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| page_size | query | Page size (1-256) | No | integer, <br>**Default:** 256 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginListResponse](#pluginlistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/list/installations/ids
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserLatest](#parserlatest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstallationsResponse](#plugininstallationsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/list/latest-versions
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserLatest](#parserlatest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginVersionsResponse](#pluginversionsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/marketplace/pkg
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| plugin_unique_identifier | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginManifestResponse](#pluginmanifestresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/parameters/dynamic-options
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| action | query | | Yes | string |
|
|
| credential_id | query | | No | string |
|
|
| parameter | query | | Yes | string |
|
|
| plugin_id | query | | Yes | string |
|
|
| provider | query | | Yes | string |
|
|
| provider_type | query | | Yes | string, <br>**Available values:** "tool", "trigger" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginDynamicOptionsResponse](#plugindynamicoptionsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/parameters/dynamic-options-with-credentials
|
|
**Fetch dynamic options using credentials directly (for edit mode)**
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserDynamicOptionsWithCredentials](#parserdynamicoptionswithcredentials)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginDynamicOptionsResponse](#plugindynamicoptionsresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/permission/change
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserPermissionChange](#parserpermissionchange)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/permission/fetch
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginPermissionResponse](#pluginpermissionresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/readme
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | | No | string, <br>**Default:** en-US |
|
|
| plugin_unique_identifier | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginReadmeResponse](#pluginreadmeresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/tasks
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| page_size | query | Page size (1-256) | No | integer, <br>**Default:** 256 |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginTasksResponse](#plugintasksresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/tasks/delete_all
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/tasks/{task_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginTaskResponse](#plugintaskresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/tasks/{task_id}/delete
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/tasks/{task_id}/delete/{identifier}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| identifier | path | | Yes | string |
|
|
| task_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/uninstall
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserUninstall](#parseruninstall)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SuccessResponse](#successresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/upgrade/github
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserGithubUpgrade](#parsergithubupgrade)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstallTaskStartResponse](#plugininstalltaskstartresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/upgrade/marketplace
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserMarketplaceUpgrade](#parsermarketplaceupgrade)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginInstallTaskStartResponse](#plugininstalltaskstartresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/upload/bundle
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginBundleUploadResponse](#pluginbundleuploadresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/upload/github
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ParserGithubUpload](#parsergithubupload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginDecodeResponse](#plugindecoderesponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/plugin/upload/pkg
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"pkg"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginDecodeResponse](#plugindecoderesponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/plugin/{category}/list
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Language used for localized label and description search | No | string, <br>**Available values:** "en_US", "ja_JP", "pt_BR", "zh_Hans", <br>**Default:** en_US |
|
|
| page | query | Page number | No | integer, <br>**Default:** 1 |
|
|
| page_size | query | Page size (1-256) | No | integer, <br>**Default:** 256 |
|
|
| query | query | Case-insensitive search query | No | string |
|
|
| tags | query | Match any plugin tag | No | [ string ] |
|
|
| category | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PluginCategoryListResponse](#plugincategorylistresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [PluginError](#pluginerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/access-policies
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [_AccessPolicyList](#_accesspolicylist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/rbac/access-policies
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_AccessPolicyCreateRequest](#_accesspolicycreaterequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Policy created | **application/json**: [AccessPolicy](#accesspolicy)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/rbac/access-policies/{policy_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/access-policies/{policy_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessPolicy](#accesspolicy)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/access-policies/{policy_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_AccessPolicyUpdateRequest](#_accesspolicyupdaterequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessPolicy](#accesspolicy)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/rbac/access-policies/{policy_id}/copy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Policy copied | **application/json**: [AccessPolicy](#accesspolicy)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/access-policy-bindings/{binding_id}/lock
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| binding_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessPolicyBindingState](#accesspolicybindingstate)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/access-policy-bindings/{binding_id}/unlock
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| binding_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessPolicyBindingState](#accesspolicybindingstate)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_DeleteMemberBindingsRequest](#_deletememberbindingsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/role-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RoleBindingsResponse](#rolebindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/agents/{agent_id}/access-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AgentAccessMatrix](#agentaccessmatrix)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/agents/{agent_id}/user-access-policies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceUserAccessPoliciesResponse](#resourceuseraccesspoliciesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/agents/{agent_id}/users/{target_account_id}/access-policies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
| target_account_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ReplaceUserAccessPolicies](#replaceuseraccesspolicies)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ReplaceUserAccessPoliciesResponse](#replaceuseraccesspoliciesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/agents/{agent_id}/whitelist
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelist](#resourcewhitelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/agents/{agent_id}/whitelist
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ResourceAccessScopeRequest](#_resourceaccessscoperequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelist](#resourcewhitelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/agents/{agent_id}/whitelist_config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| agent_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelistConfig](#resourcewhitelistconfig)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_DeleteMemberBindingsRequest](#_deletememberbindingsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/role-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RoleBindingsResponse](#rolebindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/apps/{app_id}/access-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AppAccessMatrix](#appaccessmatrix)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/apps/{app_id}/user-access-policies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceUserAccessPoliciesResponse](#resourceuseraccesspoliciesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/apps/{app_id}/users/{target_account_id}/access-policies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
| target_account_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ReplaceUserAccessPolicies](#replaceuseraccesspolicies)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ReplaceUserAccessPoliciesResponse](#replaceuseraccesspoliciesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/apps/{app_id}/whitelist
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelist](#resourcewhitelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/apps/{app_id}/whitelist
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ResourceAccessScopeRequest](#_resourceaccessscoperequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelist](#resourcewhitelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/apps/{app_id}/whitelist_config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| app_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelistConfig](#resourcewhitelistconfig)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_DeleteMemberBindingsRequest](#_deletememberbindingsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/role-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RoleBindingsResponse](#rolebindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [DatasetAccessMatrix](#datasetaccessmatrix)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/user-access-policies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceUserAccessPoliciesResponse](#resourceuseraccesspoliciesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/datasets/{dataset_id}/users/{target_account_id}/access-policies
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
| target_account_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ReplaceUserAccessPolicies](#replaceuseraccesspolicies)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ReplaceUserAccessPoliciesResponse](#replaceuseraccesspoliciesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/whitelist
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelist](#resourcewhitelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/datasets/{dataset_id}/whitelist
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ResourceAccessScopeRequest](#_resourceaccessscoperequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelist](#resourcewhitelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/whitelist_config
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| dataset_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [ResourceWhitelistConfig](#resourcewhitelistconfig)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/members/{member_id}/rbac-roles
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| member_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberRolesResponse](#memberrolesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/members/{member_id}/rbac-roles
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| member_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ReplaceMemberRolesRequest](#_replacememberrolesrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberRolesResponse](#memberrolesresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/my-permissions
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MyPermissionsResponse](#mypermissionsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/role-permissions/catalog
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PermissionCatalogResponse](#permissioncatalogresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/role-permissions/catalog/agent
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PermissionCatalogResponse](#permissioncatalogresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/role-permissions/catalog/app
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PermissionCatalogResponse](#permissioncatalogresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/role-permissions/catalog/dataset
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [PermissionCatalogResponse](#permissioncatalogresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/roles
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| include_owner | query | | No | integer |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [_RBACRoleList](#_rbacrolelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/rbac/roles
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_RoleUpsertRequest](#_roleupsertrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Role created | **application/json**: [RBACRole](#rbacrole)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/rbac/roles/{role_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| role_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/roles/{role_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| role_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RBACRole](#rbacrole)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/roles/{role_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| role_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_RoleUpsertRequest](#_roleupsertrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RBACRole](#rbacrole)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/rbac/roles/{role_id}/copy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| role_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [CopyRoleParam](#copyroleparam)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Role copied | **application/json**: [RBACRole](#rbacrole)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/roles/{role_id}/members
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
| role_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [_MembersInRoleList](#_membersinrolelist)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/workspace/agents/access-policies/{policy_id}/bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ReplaceBindingsRequest](#_replacebindingsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessMatrixItem](#accessmatrixitem)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/agents/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/agents/access-policies/{policy_id}/role-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RoleBindingsResponse](#rolebindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/agents/access-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspaceAccessMatrix](#workspaceaccessmatrix)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/workspace/apps/access-policies/{policy_id}/bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ReplaceBindingsRequest](#_replacebindingsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessMatrixItem](#accessmatrixitem)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/apps/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/apps/access-policies/{policy_id}/role-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RoleBindingsResponse](#rolebindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/apps/access-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspaceAccessMatrix](#workspaceaccessmatrix)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/rbac/workspace/datasets/access-policies/{policy_id}/bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [_ReplaceBindingsRequest](#_replacebindingsrequest)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [AccessMatrixItem](#accessmatrixitem)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/datasets/access-policies/{policy_id}/member-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/datasets/access-policies/{policy_id}/role-bindings
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| policy_id | path | | Yes | string (uuid) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [RoleBindingsResponse](#rolebindingsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/rbac/workspace/datasets/access-policy
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Localized policy label language | No | string, <br>**Available values:** "en", "ja", "zh" |
|
|
| limit | query | | No | integer |
|
|
| page | query | | No | integer |
|
|
| reverse | query | | No | boolean |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspaceAccessMatrix](#workspaceaccessmatrix)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| keyword | query | Search keyword matching skill name or description. | No | string |
|
|
| limit | query | Number of items per page. | No | integer, <br>**Default:** 20 |
|
|
| page | query | Page number. | No | integer, <br>**Default:** 1 |
|
|
| tag | query | Skill tag filters. Repeat the parameter for multiple tags. | No | [ string ] |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workspace skills | **application/json**: [SkillListResponse](#skilllistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillCreatePayload](#skillcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Skill created | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/files/upload
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Skill draft file uploaded | **application/json**: [SkillFileUploadResponse](#skillfileuploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [FilenameMissingError](#filenamemissingerror)<br>[NoFileUploadedError](#nofileuploadederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/import
|
|
Import a Skill zip package from multipart form field `file`.
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Skill imported | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/tags
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workspace Skill tags | **application/json**: [SkillTagListResponse](#skilltaglistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/skills/{skill_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillDeletePayload](#skilldeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill deleted | **application/json**: [SkillDeleteResponse](#skilldeleteresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill detail | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/skills/{skill_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillMetadataPayload](#skillmetadatapayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill updated | **application/json**: [SkillResponse](#skillresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/{skill_id}/assist/messages
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillAssistMessagePayload](#skillassistmessagepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill Authoring assistant event stream | |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/{skill_id}/duplicate
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Skill duplicated | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}/export
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft Skill zip archive | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/skills/{skill_id}/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillDraftFileOperationPayload](#skilldraftfileoperationpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft file operation applied | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/skills/{skill_id}/files
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillDraftTreePayload](#skilldrafttreepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft files replaced | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/{skill_id}/files/check
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillDraftFileCheckPayload](#skilldraftfilecheckpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Draft files checked | **application/json**: [SkillFileCheckResponse](#skillfilecheckresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}/files/content
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| download | query | Return as an attachment when 1. | No | string |
|
|
| path | query | Skill file path relative to the Skill root. | Yes | string |
|
|
| version_id | query | Optional published version ID. Omit for current draft. | No | string |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill file content | `*/*`: binary<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}/files/preview
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| path | query | Skill file path relative to the Skill root. | Yes | string |
|
|
| version_id | query | Optional published version ID. Omit for current draft. | No | string |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill file text preview | **application/json**: [SkillFilePreviewResponse](#skillfilepreviewresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/{skill_id}/publish
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillPublishPayload](#skillpublishpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill published | **application/json**: [SkillVersionResponse](#skillversionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}/references
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill references | **application/json**: [SkillReferenceListResponse](#skillreferencelistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/skills/{skill_id}/restore
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillRestorePayload](#skillrestorepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill version restored to draft | **application/json**: [SkillDetailResponse](#skilldetailresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}/versions
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill versions | **application/json**: [SkillVersionListResponse](#skillversionlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/skills/{skill_id}/versions/{version_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
| version_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill version deleted | **application/json**: [SkillVersionDeleteResponse](#skillversiondeleteresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/skills/{skill_id}/versions/{version_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
| version_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill version detail | **application/json**: [SkillVersionDetailResponse](#skillversiondetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PATCH] /workspaces/current/skills/{skill_id}/versions/{version_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| skill_id | path | | Yes | string |
|
|
| version_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SkillVersionUpdatePayload](#skillversionupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Skill version updated | **application/json**: [SkillVersionResponse](#skillversionresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [InvalidRequestError](#invalidrequesterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/summary
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [CurrentWorkspaceSummaryResponse](#currentworkspacesummaryresponse)<br> |
|
|
| 409 | Current workspace is archived | **application/json**: [CurrentWorkspaceArchivedError](#currentworkspacearchivederror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-labels
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Tool labels retrieved successfully | **application/json**: [ToolLabelListResponse](#toollabellistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/api/add
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ApiToolProviderAddPayload](#apitoolprovideraddpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API provider added successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/api/delete
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ApiToolProviderDeletePayload](#apitoolproviderdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API provider deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/api/get
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API provider retrieved successfully | **application/json**: [ApiProviderDetailResponse](#apiproviderdetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/api/remote
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| url | query | | Yes | string (uri) |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Remote API provider schema retrieved successfully | **application/json**: [ApiProviderRemoteSchemaResponse](#apiproviderremoteschemaresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/api/schema
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ApiToolSchemaPayload](#apitoolschemapayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API schema parsed successfully | **application/json**: [ApiSchemaParseResponse](#apischemaparseresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/api/test/pre
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ApiToolTestPayload](#apitooltestpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API tool test preview completed successfully | **application/json**: [ApiToolPreviewResponse](#apitoolpreviewresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/api/tools
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API provider tools retrieved successfully | **application/json**: [ToolApiListResponse](#toolapilistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/api/update
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ApiToolProviderUpdatePayload](#apitoolproviderupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API provider updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/builtin/{provider}/add
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [BuiltinToolAddPayload](#builtintooladdpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider added successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/credential/info
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| include_credential_ids | query | Credential IDs to include even if visibility would hide them | No | [ string ] |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider credential info retrieved successfully | **application/json**: [ToolProviderCredentialInfoApiEntity](#toolprovidercredentialinfoapientity)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/credential/schema/{credential_type}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| credential_type | path | | Yes | string |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider credential schema retrieved successfully | **application/json**: [ProviderConfigListResponse](#providerconfiglistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/credentials
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| include_credential_ids | query | Credential IDs to include even if visibility would hide them | No | [ string ] |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider credentials retrieved successfully | **application/json**: [ToolProviderCredentialListResponse](#toolprovidercredentiallistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/builtin/{provider}/default-credential
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [BuiltinProviderDefaultCredentialPayload](#builtinproviderdefaultcredentialpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Default credential set successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/builtin/{provider}/delete
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [BuiltinToolCredentialDeletePayload](#builtintoolcredentialdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider credential deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/icon
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider icon | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/info
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider info retrieved successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/client-schema
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider OAuth client schema retrieved successfully | **application/json**: [BuiltinProviderOAuthClientSchemaResponse](#builtinprovideroauthclientschemaresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Custom OAuth client deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Custom OAuth client retrieved successfully | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/builtin/{provider}/oauth/custom-client
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [ToolOAuthCustomClientPayload](#tooloauthcustomclientpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Custom OAuth client saved successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/builtin/{provider}/tools
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider tools retrieved successfully | **application/json**: [ToolApiListResponse](#toolapilistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/builtin/{provider}/update
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [BuiltinToolUpdatePayload](#builtintoolupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin provider updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/tool-provider/mcp
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MCPProviderDeletePayload](#mcpproviderdeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/mcp
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MCPProviderCreatePayload](#mcpprovidercreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP provider created successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [PUT] /workspaces/current/tool-provider/mcp
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MCPProviderUpdatePayload](#mcpproviderupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP provider updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/mcp/auth
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [MCPAuthPayload](#mcpauthpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP provider authorized successfully | **application/json**: [MCPAuthResponse](#mcpauthresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/mcp/tools/{provider_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP provider retrieved successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/mcp/update/{provider_id}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP provider tools refreshed successfully | **application/json**: [ToolProviderApiEntityResponse](#toolproviderapientityresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/workflow/create
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowToolCreatePayload](#workflowtoolcreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow tool created successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/workflow/delete
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowToolDeletePayload](#workflowtooldeletepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow tool deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/workflow/get
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| workflow_app_id | query | | No | string |
|
|
| workflow_tool_id | query | | No | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow tool retrieved successfully | **application/json**: [WorkflowToolDetailResponse](#workflowtooldetailresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-provider/workflow/tools
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| workflow_tool_id | query | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow provider tools retrieved successfully | **application/json**: [ToolApiListResponse](#toolapilistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/tool-provider/workflow/update
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkflowToolUpdatePayload](#workflowtoolupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow tool updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tool-providers
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| type | query | | No | string, <br>**Available values:** "api", "builtin", "mcp", "model", "workflow" |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Tool providers retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tools/api
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | API tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tools/builtin
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Builtin tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tools/mcp
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | MCP tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/tools/workflow
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Workflow tools retrieved successfully | **application/json**: [ToolProviderListResponse](#toolproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/icon
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger provider icon | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/info
|
|
**Get info for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger provider retrieved successfully | **application/json**: [TriggerProviderApiEntity](#triggerproviderapientity)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [DELETE] /workspaces/current/trigger-provider/{provider}/oauth/client
|
|
**Remove custom OAuth client configuration**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger OAuth client deleted successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/oauth/client
|
|
**Get OAuth client configuration for a provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger OAuth client retrieved successfully | **application/json**: [TriggerOAuthClientResponse](#triggeroauthclientresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{provider}/oauth/client
|
|
**Configure custom OAuth client for a provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerOAuthClientPayload](#triggeroauthclientpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger OAuth client saved successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/build/{subscription_builder_id}
|
|
**Build a subscription instance for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
| subscription_builder_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription builder built successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/create
|
|
**Add a new subscription instance for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerSubscriptionBuilderCreatePayload](#triggersubscriptionbuildercreatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription builder created successfully | **application/json**: [TriggerSubscriptionBuilderCreateResponse](#triggersubscriptionbuildercreateresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/logs/{subscription_builder_id}
|
|
**Get the request logs for a subscription instance for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
| subscription_builder_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription builder logs retrieved successfully | **application/json**: [TriggerSubscriptionBuilderLogsResponse](#triggersubscriptionbuilderlogsresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/update/{subscription_builder_id}
|
|
**Update a subscription instance for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
| subscription_builder_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription builder updated successfully | **application/json**: [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/verify-and-update/{subscription_builder_id}
|
|
**Verify and update a subscription instance for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
| subscription_builder_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerSubscriptionBuilderVerifyPayload](#triggersubscriptionbuilderverifypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription builder verified successfully | **application/json**: [TriggerVerificationResponse](#triggerverificationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/builder/{subscription_builder_id}
|
|
**Get a subscription instance for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
| subscription_builder_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription builder retrieved successfully | **application/json**: [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/list
|
|
**List all trigger subscriptions for the current tenant's provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscriptions retrieved successfully | **application/json**: [TriggerProviderSubscriptionListResponse](#triggerprovidersubscriptionlistresponse)<br> |
|
|
| 404 | Trigger provider not found | **application/json**: [TriggerProviderErrorResponse](#triggerprovidererrorresponse)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/trigger-provider/{provider}/subscriptions/oauth/authorize
|
|
**Initiate OAuth authorization flow for a trigger provider**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger OAuth authorization URL generated successfully | **application/json**: [TriggerOAuthAuthorizeResponse](#triggeroauthauthorizeresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{provider}/subscriptions/verify/{subscription_id}
|
|
**Verify credentials for an existing subscription (edit mode only)**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| provider | path | | Yes | string |
|
|
| subscription_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerSubscriptionVerifyPayload](#triggersubscriptionverifypayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription verified successfully | **application/json**: [TriggerVerificationResponse](#triggerverificationresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/delete
|
|
**Delete a subscription instance**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| subscription_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/current/trigger-provider/{subscription_id}/subscriptions/update
|
|
**Update a subscription instance**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| subscription_id | path | | Yes | string |
|
|
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [TriggerSubscriptionBuilderUpdatePayload](#triggersubscriptionbuilderupdatepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger subscription updated successfully | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/current/triggers
|
|
**List all trigger providers for the current tenant**
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Trigger providers retrieved successfully | **application/json**: [TriggerProviderListResponse](#triggerproviderlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/custom-config
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspaceCustomConfigResponse](#workspacecustomconfigresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/custom-config
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkspaceCustomConfigPayload](#workspacecustomconfigpayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspaceTenantResultResponse](#workspacetenantresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/custom-config/webapp-logo/upload
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **multipart/form-data**: { **"file"**: binary }<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Logo uploaded | **application/json**: [WorkspaceLogoUploadResponse](#workspacelogouploadresponse)<br> |
|
|
| 400 | Bad Request | **application/json**: [FilenameNotExistsError](#filenamenotexistserror)<br>[NoFileUploadedError](#nofileuploadederror)<br>[TooManyFilesError](#toomanyfileserror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 413 | Request Entity Too Large | **application/json**: [FileTooLargeError](#filetoolargeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| 415 | Unsupported Media Type | **application/json**: [UnsupportedFileTypeError](#unsupportedfiletypeerror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/info
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [WorkspaceInfoPayload](#workspaceinfopayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [WorkspaceTenantResultResponse](#workspacetenantresultresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [POST] /workspaces/switch
|
|
#### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SwitchWorkspacePayload](#switchworkspacepayload)<br> |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [SwitchWorkspaceResponse](#switchworkspaceresponse)<br> |
|
|
| 403 | Forbidden | **application/json**: [AccountNotLinkTenantError](#accountnotlinktenanterror)<br>[ErrorResponse](#errorresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
### [GET] /workspaces/{tenant_id}/model-providers/{provider}/{icon_type}/{lang}
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| icon_type | path | | Yes | string |
|
|
| lang | path | | Yes | string |
|
|
| provider | path | | Yes | string |
|
|
| tenant_id | path | | Yes | string |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Model provider icon | |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
---
|
|
## default
|
|
Default namespace
|
|
|
|
### [GET] /explore/banners
|
|
**Get banner list**
|
|
|
|
#### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| language | query | Banner language | No | string, <br>**Default:** en-US |
|
|
|
|
#### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | Success | **application/json**: [BannerListResponse](#bannerlistresponse)<br> |
|
|
| default | Error | **application/json**: [ErrorResponse](#errorresponse)<br> |
|
|
|
|
---
|
|
### Schemas
|
|
|
|
#### AIModelEntity
|
|
|
|
Model class for AI model.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deprecated | boolean | | No |
|
|
| features | [ [ModelFeature](#modelfeature) ] | | No |
|
|
| fetch_from | [FetchFrom](#fetchfrom) | | Yes |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| model | string | | Yes |
|
|
| model_properties | object | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| parameter_rules | [ [ParameterRule](#parameterrule) ], <br>**Default:** | | No |
|
|
| pricing | [PriceConfig](#priceconfig) | | No |
|
|
|
|
#### AIModelEntityResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deprecated | boolean | | No |
|
|
| features | [ [ModelFeature](#modelfeature) ] | | No |
|
|
| fetch_from | [FetchFrom](#fetchfrom) | | Yes |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| model | string | | Yes |
|
|
| model_properties | object | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| parameter_rules | [ [ParameterRule](#parameterrule) ], <br>**Default:** | | No |
|
|
| pricing | [PriceConfigResponse](#priceconfigresponse) | | No |
|
|
|
|
#### APIBasedExtensionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| APIBasedExtensionListResponse | array | | |
|
|
|
|
#### APIBasedExtensionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_endpoint | string | API endpoint URL | Yes |
|
|
| api_key | string | API key for authentication | Yes |
|
|
| name | string | Extension name | Yes |
|
|
|
|
#### APIBasedExtensionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_endpoint | string | | Yes |
|
|
| api_key | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### AccessDeniedError
|
|
|
|
App access denied.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AccessDeniedError | | App access denied. | |
|
|
|
|
#### AccessMatrixItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| accounts | [ [AccessPolicyAccount](#accesspolicyaccount) ] | | No |
|
|
| policy | [AccessPolicy](#accesspolicy) | | No |
|
|
| roles | [ [AccessPolicyRole](#accesspolicyrole) ] | | No |
|
|
|
|
#### AccessPolicy
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | string | | No |
|
|
| created_at | integer | | No |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| is_builtin | boolean | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| policy_key | string | | No |
|
|
| resource_type | string | | Yes |
|
|
| tenant_id | string | | No |
|
|
| updated_at | integer | | No |
|
|
|
|
#### AccessPolicyAccount
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | Yes |
|
|
| account_name | string | | Yes |
|
|
| avatar | string | | No |
|
|
| binding_id | string | | Yes |
|
|
| email | string | | No |
|
|
| is_locked | boolean | | No |
|
|
|
|
#### AccessPolicyBindingState
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binding_id | string | | Yes |
|
|
| is_locked | boolean | | No |
|
|
|
|
#### AccessPolicyMemberBinding
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_policy_id | string | | Yes |
|
|
| account_id | string | | Yes |
|
|
| account_name | string | | No |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| resource_id | string | | No |
|
|
| resource_type | string | | Yes |
|
|
| tenant_id | string | | No |
|
|
|
|
#### AccessPolicyRole
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binding_id | string | | Yes |
|
|
| is_locked | boolean | | No |
|
|
| role_id | string | | Yes |
|
|
| role_name | string | | Yes |
|
|
| role_tag | string | | No |
|
|
|
|
#### AccessPolicyRoleBinding
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_policy_id | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| resource_id | string | | No |
|
|
| resource_type | string | | Yes |
|
|
| role_id | string | | Yes |
|
|
| role_name | string | | No |
|
|
| tenant_id | string | | No |
|
|
|
|
#### AccountAlreadyInitedError
|
|
|
|
The account has been initialized. Please refresh the page.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AccountAlreadyInitedError | | The account has been initialized. Please refresh the page. | |
|
|
|
|
#### AccountAvatarQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | Avatar file ID | Yes |
|
|
|
|
#### AccountBannedError
|
|
|
|
Account is banned.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AccountBannedError | | Account is banned. | |
|
|
|
|
#### AccountDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### AccountDeletionFeedbackPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| feedback | string | | Yes |
|
|
|
|
#### AccountInFreezeError
|
|
|
|
This email account has been deleted within the past 30 days and is temporarily unavailable for new account registration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AccountInFreezeError | | This email account has been deleted within the past 30 days and is temporarily unavailable for new account registration. | |
|
|
|
|
#### AccountInitPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| interface_language | string | | Yes |
|
|
| invitation_code | string | | No |
|
|
| timezone | string | | Yes |
|
|
|
|
#### AccountIntegrateListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AccountIntegrateResponse](#accountintegrateresponse) ] | | Yes |
|
|
|
|
#### AccountIntegrateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| is_bound | boolean | | Yes |
|
|
| link | string | | No |
|
|
| provider | string | | Yes |
|
|
|
|
#### AccountNotFoundError
|
|
|
|
Account not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AccountNotFoundError | | Account not found. | |
|
|
|
|
#### AccountNotLinkTenantError
|
|
|
|
Account not link tenant.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AccountNotLinkTenantError | | Account not link tenant. | |
|
|
|
|
#### AccountPasswordPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_password | string | | Yes |
|
|
| password | string | | No |
|
|
| repeat_new_password | string | | Yes |
|
|
|
|
#### AccountProfilePatchPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| interface_language | string | | No |
|
|
| interface_theme | string, <br>**Available values:** "dark", "light" | *Enum:* `"dark"`, `"light"` | No |
|
|
| name | string | | No |
|
|
| timezone | string | | No |
|
|
|
|
#### AccountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| avatar_url | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| interface_language | string | | No |
|
|
| interface_theme | string | | No |
|
|
| is_password_set | boolean | | Yes |
|
|
| last_login_at | integer | | No |
|
|
| last_login_ip | string | | No |
|
|
| name | string | | Yes |
|
|
| timezone | string | | No |
|
|
|
|
#### AccountWithRoleListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| accounts | [ [AccountWithRoleResponse](#accountwithroleresponse) ] | | Yes |
|
|
|
|
#### AccountWithRoleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| avatar_url | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| last_active_at | integer | | No |
|
|
| last_login_at | integer | | No |
|
|
| name | string | | Yes |
|
|
| role | string | | Yes |
|
|
| roles | [ [MemberRoleSummaryResponse](#memberrolesummaryresponse) ] | | No |
|
|
| status | string | | Yes |
|
|
|
|
#### ActivateCheckQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | No |
|
|
| token | string | | Yes |
|
|
| workspace_id | string | | No |
|
|
|
|
#### ActivatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | No |
|
|
| interface_language | string | | No |
|
|
| name | string | | No |
|
|
| timezone | string | | No |
|
|
| token | string | | Yes |
|
|
| workspace_id | string | | No |
|
|
|
|
#### ActivationCheckData
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_status | string | | No |
|
|
| email | string | | Yes |
|
|
| requires_setup | boolean | | No |
|
|
| workspace_id | string | | Yes |
|
|
| workspace_name | string | | Yes |
|
|
|
|
#### ActivationCheckResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ActivationCheckData](#activationcheckdata) | Activation data if valid | No |
|
|
| is_valid | boolean | Whether token is valid | Yes |
|
|
|
|
#### ActivationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Operation result | Yes |
|
|
|
|
#### AddPlatformContactsRequest
|
|
|
|
Request body for adding one or more organization members as platform contacts.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| candidate_ids | [ string ] | Organization candidate identifiers to project into the current workspace as platform contacts. | Yes |
|
|
|
|
#### AddPlatformContactsResponse
|
|
|
|
Response body for adding platform contacts.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [HumanInputContact](#humaninputcontact) ] | Contacts created by the current add operation. | Yes |
|
|
|
|
#### AdvancedChatWorkflowRunForListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| elapsed_time | number | | No |
|
|
| exceptions_count | integer | | No |
|
|
| finished_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| message_id | string | | No |
|
|
| retry_index | integer | | No |
|
|
| status | string | | No |
|
|
| total_steps | integer | | No |
|
|
| total_tokens | integer | | No |
|
|
| version | string | | No |
|
|
|
|
#### AdvancedChatWorkflowRunPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AdvancedChatWorkflowRunForListResponse](#advancedchatworkflowrunforlistresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
|
|
#### AdvancedChatWorkflowRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | | No |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | No |
|
|
| parent_message_id | string | | No |
|
|
| query | string | | No |
|
|
|
|
#### AdvancedPromptTemplateQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_mode | string | Application mode | Yes |
|
|
| has_context | string, <br>**Default:** true | Whether has context | No |
|
|
| model_mode | string | Model mode | Yes |
|
|
| model_name | string | Model name | Yes |
|
|
|
|
#### AdvancedPromptTemplateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chat_prompt_config | [ChatPromptTemplateResponse](#chatprompttemplateresponse) | | No |
|
|
| completion_prompt_config | [CompletionPromptTemplateResponse](#completionprompttemplateresponse) | | No |
|
|
| stop | [ string ] | Stop words for completion prompts. | No |
|
|
|
|
#### AgentAccessMatrix
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | No |
|
|
| items | [ [AccessMatrixItem](#accessmatrixitem) ] | | No |
|
|
|
|
#### AgentApiAccessResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_ready | boolean | | Yes |
|
|
| api_key_count | integer | | Yes |
|
|
| api_rph | integer | | Yes |
|
|
| api_rpm | integer | | Yes |
|
|
| chat_endpoint | string | | Yes |
|
|
| conversations_endpoint | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| files_upload_endpoint | string | | Yes |
|
|
| info_endpoint | string | | Yes |
|
|
| messages_endpoint | string | | Yes |
|
|
| meta_endpoint | string | | Yes |
|
|
| parameters_endpoint | string | | Yes |
|
|
| service_api_base_url | string | | Yes |
|
|
| stop_endpoint | string | | Yes |
|
|
| streaming_only | boolean, <br>**Default:** true | | No |
|
|
|
|
#### AgentApiStatusPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enable_api | boolean | Enable or disable Agent service API | Yes |
|
|
|
|
#### AgentAppComposerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_is_published | boolean | | Yes |
|
|
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) | | No |
|
|
| agent | [AgentComposerAgentResponse](#agentcomposeragentresponse) | | Yes |
|
|
| agent_soul | [AgentSoulConfig](#agentsoulconfig) | | Yes |
|
|
| app_id | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| chat_endpoint | string | | No |
|
|
| draft | [AgentConfigDraftSummaryResponse](#agentconfigdraftsummaryresponse) | | No |
|
|
| hidden_app_backed | boolean | | No |
|
|
| save_options | [ [ComposerSaveStrategy](#composersavestrategy) ] | | Yes |
|
|
| validation | [ComposerValidationFindingsResponse](#composervalidationfindingsresponse) | | No |
|
|
| variant | string | | Yes |
|
|
|
|
#### AgentAppCopyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | Description for the copied agent | No |
|
|
| icon | string | Icon | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
| name | string | Name for the copied agent | No |
|
|
| role | string | Role for the copied agent | No |
|
|
|
|
#### AgentAppCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | Agent description (max 400 chars) | No |
|
|
| icon | string | Icon | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
| name | string | Agent name | Yes |
|
|
| role | string | Agent role | No |
|
|
|
|
#### AgentAppDetailWithSite
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_mode | [WebAppAccessMode](#webappaccessmode) | | Yes |
|
|
| access_ready | boolean | | No |
|
|
| api_base_url | string | | Yes |
|
|
| app_id | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| bound_agent_id | string | | No |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| debug_conversation_has_messages | boolean | | No |
|
|
| debug_conversation_id | string | | No |
|
|
| debug_conversation_message_count | integer | | No |
|
|
| deleted_tools | [ [DeletedTool](#deletedtool) ] | | Yes |
|
|
| description | string | | Yes |
|
|
| enable_api | boolean | | Yes |
|
|
| enable_site | boolean | | Yes |
|
|
| hidden_app_backed | boolean | | No |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | Yes |
|
|
| icon_type | [IconType](#icontype) | | Yes |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| maintainer | string | | Yes |
|
|
| max_active_requests | integer | | Yes |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| model_config | [AppModelConfigResponse](#appmodelconfigresponse) | | Yes |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | Yes |
|
|
| role | string | | No |
|
|
| site | [AppDetailSiteResponse](#appdetailsiteresponse) | | Yes |
|
|
| tags | [ [Tag](#tag) ] | | Yes |
|
|
| tracing | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
| workflow | [WorkflowPartial](#workflowpartial) | | Yes |
|
|
|
|
#### AgentAppFeaturesPayload
|
|
|
|
Presentation features configurable on an Agent App.
|
|
|
|
All fields are optional; an omitted field is reset to its disabled/empty
|
|
default (the config form sends the full desired feature state on save).
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| opening_statement | string | Conversation opener shown before the first turn | No |
|
|
| retriever_resource | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) | Citations / attributions config, e.g. {'enabled': true} | No |
|
|
| sensitive_word_avoidance | [AgentSensitiveWordAvoidanceFeatureConfig](#agentsensitivewordavoidancefeatureconfig) | Content moderation config | No |
|
|
| speech_to_text | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) | Speech-to-text config | No |
|
|
| suggested_questions | [ string ] | Preset questions shown alongside the opener | No |
|
|
| suggested_questions_after_answer | [AgentSuggestedQuestionsAfterAnswerFeatureConfig](#agentsuggestedquestionsafteranswerfeatureconfig) | Follow-up suggestions config, e.g. {'enabled': true} | No |
|
|
| text_to_speech | [AgentTextToSpeechFeatureConfig](#agenttexttospeechfeatureconfig) | Text-to-speech config | No |
|
|
|
|
#### AgentAppListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| creator_ids | [ string ] | Filter by creator account IDs | No |
|
|
| is_created_by_me | boolean | Filter by creator | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all | App mode filter<br>*Enum:* `"advanced-chat"`, `"agent"`, `"agent-chat"`, `"all"`, `"channel"`, `"chat"`, `"completion"`, `"workflow"` | No |
|
|
| name | string | Filter by app name | No |
|
|
| openapi_visible | boolean | Only return apps with API access enabled | No |
|
|
| page | integer, <br>**Default:** 1 | Page number (1-99999) | No |
|
|
| publication_status | string, <br>**Available values:** "drafts", "published" | Filter by published or draft Agent configuration status | No |
|
|
| sort_by | string, <br>**Available values:** "earliest_created", "last_modified", "recently_created", <br>**Default:** last_modified | Sort apps by last modified, recently created, or earliest created<br>*Enum:* `"earliest_created"`, `"last_modified"`, `"recently_created"` | No |
|
|
| tag_ids | [ string ] | Filter by tag IDs | No |
|
|
|
|
#### AgentAppPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentAppPartial](#agentapppartial) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| publication_counts | [AgentPublicationCountsResponse](#agentpublicationcountsresponse) | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AgentAppPartial
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_mode | [WebAppAccessMode](#webappaccessmode) | | No |
|
|
| active_config_is_published | boolean | | No |
|
|
| app_id | string | | No |
|
|
| author_name | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| bound_agent_id | string | | No |
|
|
| create_user_name | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| debug_conversation_id | string | | No |
|
|
| description | string | | No |
|
|
| has_draft_trigger | boolean | | No |
|
|
| hidden_app_backed | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [IconType](#icontype) | | No |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| is_starred | boolean | | No |
|
|
| maintainer | string | | No |
|
|
| max_active_requests | integer | | No |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| model_config | [ModelConfigPartial](#modelconfigpartial) | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | Yes |
|
|
| published_reference_count | integer | | No |
|
|
| published_references | [ [AgentAppPublishedReferenceResponse](#agentapppublishedreferenceresponse) ] | | No |
|
|
| reference_count | integer | | No |
|
|
| role | string | | No |
|
|
| tags | [ [Tag](#tag) ] | | No |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| use_icon_as_answer_icon | boolean | | No |
|
|
| workflow | [WorkflowPartial](#workflowpartial) | | No |
|
|
|
|
#### AgentAppPublishedReferenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_icon | string | | No |
|
|
| app_icon_background | string | | No |
|
|
| app_icon_type | string | | No |
|
|
| app_id | string | | Yes |
|
|
| app_name | string | | Yes |
|
|
|
|
#### AgentAppUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | App description (max 400 chars) | No |
|
|
| icon | string | Icon | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
| max_active_requests | integer | Maximum active requests | No |
|
|
| name | string | App name | Yes |
|
|
| role | string | Agent role | No |
|
|
| use_icon_as_answer_icon | boolean | Use icon as answer icon | No |
|
|
|
|
#### AgentAudioTranscriptFormPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| draft_type | [AgentConfigDraftType](#agentconfigdrafttype) | | No |
|
|
|
|
#### AgentAverageResponseTimeStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| latency | number | | Yes |
|
|
|
|
#### AgentAverageSessionInteractionStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| interactions | number | | Yes |
|
|
|
|
#### AgentBackendUnreachableError
|
|
|
|
Agent backend is unreachable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentBackendUnreachableError | | Agent backend is unreachable. | |
|
|
|
|
#### AgentBuildDraftApplyResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| draft | object | | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### AgentBuildDraftCheckoutPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| force | boolean | Overwrite the existing current-user build draft | No |
|
|
|
|
#### AgentBuildDraftResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_soul | [AgentSoulConfig](#agentsoulconfig) | | Yes |
|
|
| draft | [AgentConfigDraftSummaryResponse](#agentconfigdraftsummaryresponse) | | Yes |
|
|
| variant | string | | Yes |
|
|
|
|
#### AgentBuildSandboxNotFoundError
|
|
|
|
The retained Build Sandbox is no longer available.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentBuildSandboxNotFoundError | | The retained Build Sandbox is no longer available. | |
|
|
|
|
#### AgentCliToolAuthorizationStatus
|
|
|
|
Authorization state for Agent-scoped CLI tools.
|
|
|
|
Missing status keeps backward compatibility with draft rows and CLI tools that
|
|
do not need pre-authorization. Explicit denied-like states are blocked by the
|
|
composer/publish validators and skipped by runtime request builders.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentCliToolAuthorizationStatus | string | Authorization state for Agent-scoped CLI tools. Missing status keeps backward compatibility with draft rows and CLI tools that do not need pre-authorization. Explicit denied-like states are blocked by the composer/publish validators and skipped by runtime request builders. | |
|
|
|
|
#### AgentCliToolConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| approved | boolean | | No |
|
|
| authorization_status | [AgentCliToolAuthorizationStatus](#agentclitoolauthorizationstatus) | | No |
|
|
| command | string | | No |
|
|
| dangerous | boolean | | No |
|
|
| dangerous_accepted | boolean | | No |
|
|
| dangerous_acknowledged | boolean | | No |
|
|
| dangerous_command | boolean | | No |
|
|
| description | string | | No |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| env | [AgentCliToolEnvConfig](#agentclitoolenvconfig) | | No |
|
|
| id | string | | No |
|
|
| inferred_from | string | | No |
|
|
| install | string | | No |
|
|
| install_command | string | | No |
|
|
| install_commands | [ string ] | | No |
|
|
| invoke_metadata | object | | No |
|
|
| label | string | | No |
|
|
| name | string | | No |
|
|
| permission | [AgentPermissionConfig](#agentpermissionconfig) | | No |
|
|
| pre_authorized | boolean | | No |
|
|
| requires_confirmation | boolean | | No |
|
|
| risk_accepted | boolean | | No |
|
|
| risk_level | [AgentCliToolRiskLevel](#agentclitoolrisklevel) | | No |
|
|
| setup_command | string | | No |
|
|
| tool_name | string | | No |
|
|
|
|
#### AgentCliToolEnvConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| secret_refs | [ [AgentSecretRefConfig](#agentsecretrefconfig) ] | | No |
|
|
| variables | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] | | No |
|
|
|
|
#### AgentCliToolRiskLevel
|
|
|
|
Risk marker for CLI tool bootstrap commands.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentCliToolRiskLevel | string | Risk marker for CLI tool bootstrap commands. | |
|
|
|
|
#### AgentComposerAgentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_snapshot_id | string | | No |
|
|
| app_id | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| description | string | | Yes |
|
|
| hidden_app_backed | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| role | string | | No |
|
|
| scope | [AgentScope](#agentscope) | | Yes |
|
|
| source | [AgentSource](#agentsource) | | No |
|
|
| status | [AgentStatus](#agentstatus) | | Yes |
|
|
|
|
#### AgentComposerBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | No |
|
|
| binding_type | [WorkflowAgentBindingType](#workflowagentbindingtype) | | Yes |
|
|
| current_snapshot_id | string | | No |
|
|
| id | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| workflow_id | string | | Yes |
|
|
|
|
#### AgentComposerCandidatesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_node_job_candidates | [AgentComposerNodeJobCandidatesResponse](#agentcomposernodejobcandidatesresponse) | | No |
|
|
| allowed_soul_candidates | [AgentComposerSoulCandidatesResponse](#agentcomposersoulcandidatesresponse) | | No |
|
|
| capabilities | [ComposerCandidateCapabilities](#composercandidatecapabilities) | | No |
|
|
| truncated | boolean | | No |
|
|
| variant | [ComposerVariant](#composervariant) | | Yes |
|
|
|
|
#### AgentComposerDifyToolCandidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| granularity | string | | No |
|
|
| id | string | | No |
|
|
| name | string | | No |
|
|
| plugin_id | string | | No |
|
|
| provider | string | | No |
|
|
| provider_id | string | | No |
|
|
| tools_count | integer | | No |
|
|
|
|
#### AgentComposerImpactBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| workflow_id | string | | Yes |
|
|
|
|
#### AgentComposerImpactResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bindings | [ [AgentComposerImpactBindingResponse](#agentcomposerimpactbindingresponse) ] | | No |
|
|
| current_snapshot_id | string | | No |
|
|
| workflow_node_count | integer | | Yes |
|
|
|
|
#### AgentComposerKnowledgeDatasetCandidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| id | string | | No |
|
|
| missing | boolean | | No |
|
|
| name | string | | No |
|
|
|
|
#### AgentComposerKnowledgeSetCandidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| control_space_id | string | | No |
|
|
| datasets | [ [AgentComposerKnowledgeDatasetCandidateResponse](#agentcomposerknowledgedatasetcandidateresponse) ] | | No |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| missing | boolean | | No |
|
|
| missing_dataset_ids | [ string ] | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### AgentComposerNodeJobCandidatesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| declare_output_types | [ [DeclaredOutputType](#declaredoutputtype) ] | | No |
|
|
| human_contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] | | No |
|
|
| previous_node_outputs | [ [WorkflowPreviousNodeOutputRef](#workflowpreviousnodeoutputref) ] | | No |
|
|
|
|
#### AgentComposerSoulCandidatesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cli_tools | [ [AgentCliToolConfig](#agentclitoolconfig) ] | | No |
|
|
| dify_tools | [ [AgentComposerDifyToolCandidateResponse](#agentcomposerdifytoolcandidateresponse) ] | | No |
|
|
| human_contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] | | No |
|
|
| knowledge_sets | [ [AgentComposerKnowledgeSetCandidateResponse](#agentcomposerknowledgesetcandidateresponse) ] | | No |
|
|
|
|
#### AgentComposerSoulLockResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| can_unlock | boolean | | No |
|
|
| locked | boolean | | Yes |
|
|
| reason | string | | No |
|
|
|
|
#### AgentComposerValidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| errors | [ string ] | | No |
|
|
| knowledge_retrieval_placeholder | [ [ComposerKnowledgePlaceholderResponse](#composerknowledgeplaceholderresponse) ] | | No |
|
|
| result | string | | Yes |
|
|
| warnings | [ [ComposerValidationWarningResponse](#composervalidationwarningresponse) ] | | No |
|
|
|
|
#### AgentConfigDeleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| removed_names | [ string ] | | No |
|
|
| result | string | | Yes |
|
|
|
|
#### AgentConfigDownloadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string | | Yes |
|
|
|
|
#### AgentConfigDraftSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | No |
|
|
| agent_id | string | | Yes |
|
|
| base_snapshot_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| draft_type | [AgentConfigDraftType](#agentconfigdrafttype) | | Yes |
|
|
| id | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
|
|
#### AgentConfigDraftType
|
|
|
|
Editable Agent Soul draft workspace type.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentConfigDraftType | string | Editable Agent Soul draft workspace type. | |
|
|
|
|
#### AgentConfigFileItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_id | string | | No |
|
|
| hash | string | | No |
|
|
| id | string | | Yes |
|
|
| is_missing | boolean | | No |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
|
|
#### AgentConfigFileItemsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [AgentConfigFileItemResponse](#agentconfigfileitemresponse) ] | | No |
|
|
|
|
#### AgentConfigFileListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | Yes |
|
|
| config_version | [AgentConfigVersionResponse](#agentconfigversionresponse) | | Yes |
|
|
| items | [ [AgentConfigFileItemResponse](#agentconfigfileitemresponse) ] | | No |
|
|
|
|
#### AgentConfigFilePreviewResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binary | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
| text | string | | No |
|
|
| truncated | boolean | | Yes |
|
|
|
|
#### AgentConfigFileRefConfig
|
|
|
|
Stable Agent Soul reference to one config file payload.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_id | string | | No |
|
|
| file_kind | string, <br>**Available values:** "tool_file", "upload_file" | *Enum:* `"tool_file"`, `"upload_file"` | Yes |
|
|
| hash | string | | No |
|
|
| is_missing | boolean | | No |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
|
|
#### AgentConfigFileUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| upload_file_id | string | UploadFile UUID from POST /console/api/files/upload | Yes |
|
|
|
|
#### AgentConfigFileUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config_version | [AgentConfigVersionResponse](#agentconfigversionresponse) | | Yes |
|
|
| file | [AgentConfigFileItemResponse](#agentconfigfileitemresponse) | | Yes |
|
|
|
|
#### AgentConfigFilesUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| upload_file_ids | [ string (uuid) ] | UploadFile UUIDs from POST /console/api/files/upload, in replacement order | Yes |
|
|
|
|
#### AgentConfigFilesUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config_version | [AgentConfigVersionResponse](#agentconfigversionresponse) | | Yes |
|
|
| files | [ [AgentConfigFileItemResponse](#agentconfigfileitemresponse) ] | | Yes |
|
|
|
|
#### AgentConfigManifestResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | Yes |
|
|
| config_version | [AgentConfigVersionResponse](#agentconfigversionresponse) | | Yes |
|
|
| env_keys | [ string ] | | No |
|
|
| files | [AgentConfigFileItemsResponse](#agentconfigfileitemsresponse) | | No |
|
|
| note | string | | No |
|
|
| skills | [AgentConfigSkillItemsResponse](#agentconfigskillitemsresponse) | | No |
|
|
|
|
#### AgentConfigRevisionOperation
|
|
|
|
Audit operation recorded for Agent Soul version/revision changes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentConfigRevisionOperation | string | Audit operation recorded for Agent Soul version/revision changes. | |
|
|
|
|
#### AgentConfigRevisionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| current_snapshot_id | string | | Yes |
|
|
| id | string | | Yes |
|
|
| operation | [AgentConfigRevisionOperation](#agentconfigrevisionoperation) | | Yes |
|
|
| previous_snapshot_id | string | | No |
|
|
| revision | integer | | Yes |
|
|
| summary | string | | No |
|
|
| version_note | string | | No |
|
|
|
|
#### AgentConfigSkillFilePreviewResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binary | boolean | | Yes |
|
|
| path | string | | Yes |
|
|
| size | integer | | No |
|
|
| text | string | | No |
|
|
| truncated | boolean | | Yes |
|
|
|
|
#### AgentConfigSkillFileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| downloadable | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| path | string | | Yes |
|
|
| previewable | boolean | | Yes |
|
|
| type | string, <br>**Available values:** "directory", "file" | *Enum:* `"directory"`, `"file"` | Yes |
|
|
|
|
#### AgentConfigSkillInspectResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| file_tree | [ object ] | | No |
|
|
| files | [ [AgentConfigSkillFileResponse](#agentconfigskillfileresponse) ] | | No |
|
|
| hash | string | | No |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
| skill_md | [AgentConfigSkillMarkdownResponse](#agentconfigskillmarkdownresponse) | | Yes |
|
|
| source | string | | Yes |
|
|
| warnings | [ string ] | | No |
|
|
|
|
#### AgentConfigSkillItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| file_id | string | | No |
|
|
| hash | string | | No |
|
|
| id | string | | Yes |
|
|
| is_missing | boolean | | No |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
|
|
#### AgentConfigSkillItemsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [AgentConfigSkillItemResponse](#agentconfigskillitemresponse) ] | | No |
|
|
|
|
#### AgentConfigSkillListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | Yes |
|
|
| config_version | [AgentConfigVersionResponse](#agentconfigversionresponse) | | Yes |
|
|
| items | [ [AgentConfigSkillItemResponse](#agentconfigskillitemresponse) ] | | No |
|
|
|
|
#### AgentConfigSkillMarkdownResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binary | boolean | | Yes |
|
|
| path | string | | Yes |
|
|
| size | integer | | No |
|
|
| text | string | | Yes |
|
|
| truncated | boolean | | Yes |
|
|
|
|
#### AgentConfigSkillRefConfig
|
|
|
|
Stable Agent Soul reference to one normalized skill archive.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| file_id | string | | No |
|
|
| file_kind | string, <br>**Default:** tool_file | | No |
|
|
| hash | string | | No |
|
|
| is_missing | boolean | | No |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
|
|
#### AgentConfigSkillUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config_version | [AgentConfigVersionResponse](#agentconfigversionresponse) | | Yes |
|
|
| skill | [AgentConfigSkillItemResponse](#agentconfigskillitemresponse) | | Yes |
|
|
|
|
#### AgentConfigSnapshotDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | No |
|
|
| config_snapshot | [AgentSoulConfig](#agentsoulconfig) | | Yes |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| display_version | integer | | No |
|
|
| id | string | | Yes |
|
|
| revisions | [ [AgentConfigRevisionResponse](#agentconfigrevisionresponse) ] | | No |
|
|
| snapshot_version | integer | | No |
|
|
| summary | string | | No |
|
|
| version | integer | | Yes |
|
|
| version_note | string | | No |
|
|
|
|
#### AgentConfigSnapshotListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) ] | | Yes |
|
|
|
|
#### AgentConfigSnapshotRestoreResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_snapshot_id | string | | Yes |
|
|
| draft_config_id | string | | No |
|
|
| restored_version_id | string | | No |
|
|
| result | string | | Yes |
|
|
|
|
#### AgentConfigSnapshotSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| display_version | integer | | No |
|
|
| id | string | | Yes |
|
|
| snapshot_version | integer | | No |
|
|
| summary | string | | No |
|
|
| version | integer | | Yes |
|
|
| version_note | string | | No |
|
|
|
|
#### AgentConfigVersionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| kind | string, <br>**Available values:** "build_draft", "draft", "snapshot" | *Enum:* `"build_draft"`, `"draft"`, `"snapshot"` | Yes |
|
|
| writable | boolean | | Yes |
|
|
|
|
#### AgentDailyConversationStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_count | integer | | Yes |
|
|
| date | string | | Yes |
|
|
|
|
#### AgentDailyEndUserStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| terminal_count | integer | | Yes |
|
|
|
|
#### AgentDailyMessageStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| message_count | integer | | Yes |
|
|
|
|
#### AgentDebugConversationRefreshResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| debug_conversation_has_messages | boolean | | No |
|
|
| debug_conversation_id | string | | Yes |
|
|
| debug_conversation_message_count | integer | | No |
|
|
|
|
#### AgentEnvVariableConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | string<br>integer<br>number<br>boolean<br>[ string ]<br>[ integer ]<br>[ number ]<br>[ boolean ] | | No |
|
|
| env_name | string | | No |
|
|
| key | string | | No |
|
|
| name | string | | No |
|
|
| required | boolean | | No |
|
|
| type | string | | No |
|
|
| value | string<br>integer<br>number<br>boolean<br>[ string ]<br>[ integer ]<br>[ number ]<br>[ boolean ] | | No |
|
|
| variable | string | | No |
|
|
|
|
#### AgentFeature
|
|
|
|
Agent Feature, used to describe the features of the agent strategy.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentFeature | string | Agent Feature, used to describe the features of the agent strategy. | |
|
|
|
|
#### AgentFeatureToggleConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
|
|
#### AgentFileRefConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_id | string | | No |
|
|
| id | string | | No |
|
|
| name | string | | No |
|
|
| reference | string | | No |
|
|
| remote_url | string | | No |
|
|
| tenant_id | string | | No |
|
|
| transfer_method | string | | No |
|
|
| type | string | | No |
|
|
| upload_file_id | string | | No |
|
|
| url | string | | No |
|
|
|
|
#### AgentFileUploadFeatureConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | No |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| image | [AgentFileUploadImageFeatureConfig](#agentfileuploadimagefeatureconfig) | | No |
|
|
| number_limits | integer, <br>**Default:** 3 | | No |
|
|
|
|
#### AgentFileUploadImageFeatureConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
|
|
#### AgentHomeSnapshotCreateFailedError
|
|
|
|
Failed to capture the Agent Home Snapshot.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentHomeSnapshotCreateFailedError | | Failed to capture the Agent Home Snapshot. | |
|
|
|
|
#### AgentHomeSnapshotTooLargeError
|
|
|
|
The Agent Home Snapshot exceeds the configured size limit.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentHomeSnapshotTooLargeError | | The Agent Home Snapshot exceeds the configured size limit. | |
|
|
|
|
#### AgentHumanContactConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channel | string | | No |
|
|
| contact_id | string | | No |
|
|
| contact_method | string | | No |
|
|
| email | string | | No |
|
|
| human_id | string | | No |
|
|
| id | string | | No |
|
|
| method | string | | No |
|
|
| name | string | | No |
|
|
| tenant_id | string | | No |
|
|
|
|
#### AgentHumanToolConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| name | string | | No |
|
|
|
|
#### AgentIconType
|
|
|
|
Supported icon storage formats for Agent roster entries.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentIconType | string | Supported icon storage formats for Agent roster entries. | |
|
|
|
|
#### AgentIdPath
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | Yes |
|
|
|
|
#### AgentInviteOptionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_is_published | boolean | | No |
|
|
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) | | No |
|
|
| active_config_snapshot_id | string | | No |
|
|
| agent_kind | [AgentKind](#agentkind) | | Yes |
|
|
| app_id | string | | No |
|
|
| archived_at | integer | | No |
|
|
| archived_by | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| description | string | | Yes |
|
|
| existing_node_ids | [ string ] | | No |
|
|
| hidden_app_backed | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [AgentIconType](#agenticontype) | | No |
|
|
| id | string | | Yes |
|
|
| in_current_workflow_count | integer | | No |
|
|
| is_in_current_workflow | boolean | | No |
|
|
| name | string | | Yes |
|
|
| published_node_reference_count | integer | | No |
|
|
| published_reference_count | integer | | No |
|
|
| published_references | [ [AgentPublishedReferenceResponse](#agentpublishedreferenceresponse) ] | | No |
|
|
| reference_count | integer | | No |
|
|
| role | string | | No |
|
|
| scope | [AgentScope](#agentscope) | | Yes |
|
|
| source | [AgentSource](#agentsource) | | Yes |
|
|
| status | [AgentStatus](#agentstatus) | | Yes |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| workflow_id | string | | No |
|
|
| workflow_node_id | string | | No |
|
|
|
|
#### AgentInviteOptionsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | Workflow app id for in-current-workflow markers | No |
|
|
| keyword | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### AgentInviteOptionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentInviteOptionResponse](#agentinviteoptionresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AgentIterationLogResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | string | | Yes |
|
|
| files | [ ] | | No |
|
|
| thought | string | | No |
|
|
| tokens | integer | | Yes |
|
|
| tool_calls | [ [AgentToolCallResponse](#agenttoolcallresponse) ] | | Yes |
|
|
| tool_raw | object | | Yes |
|
|
|
|
#### AgentKind
|
|
|
|
Agent implementation family.
|
|
|
|
This leaves room for future non-Dify agent implementations while keeping
|
|
the current roster/workflow APIs scoped to Dify Agent.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentKind | string | Agent implementation family. This leaves room for future non-Dify agent implementations while keeping the current roster/workflow APIs scoped to Dify Agent. | |
|
|
|
|
#### AgentKnowledgeDatasetConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| id | string | | No |
|
|
| name | string | | No |
|
|
|
|
#### AgentKnowledgeMetadataCondition
|
|
|
|
One manual metadata filter clause.
|
|
|
|
``id`` and ``metadata_id`` are UI-only bookkeeping the composer sends on
|
|
every save (a stable row key and a reference to the selected metadata
|
|
field). They are persisted here for round-tripping the composer's draft
|
|
state but are stripped before building the Agent runtime request, whose
|
|
DTO only accepts ``name``/``comparison_operator``/``value``.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| comparison_operator | string, <br>**Available values:** "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" | *Enum:* `"<"`, `"="`, `">"`, `"after"`, `"before"`, `"contains"`, `"empty"`, `"end with"`, `"in"`, `"is"`, `"is not"`, `"not contains"`, `"not empty"`, `"not in"`, `"start with"`, `"≠"`, `"≤"`, `"≥"` | Yes |
|
|
| id | string | | No |
|
|
| metadata_id | string | | No |
|
|
| name | string | | Yes |
|
|
| value | string<br>[ string ]<br>number | | No |
|
|
|
|
#### AgentKnowledgeMetadataConditions
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conditions | [ [AgentKnowledgeMetadataCondition](#agentknowledgemetadatacondition) ] | | No |
|
|
| logical_operator | string, <br>**Available values:** "and", "or", <br>**Default:** and | *Enum:* `"and"`, `"or"` | No |
|
|
|
|
#### AgentKnowledgeMetadataFilteringConfig
|
|
|
|
Per-set metadata filtering policy.
|
|
|
|
The Python attribute uses ``metadata_model_config`` for clarity because the
|
|
model belongs to metadata filtering specifically, while the external API and
|
|
generated schema keep the historical ``model_config`` field name via alias.
|
|
Mode-dependent completeness is enforced by composer publish validation so
|
|
draft saves can persist partially configured metadata filters.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conditions | [AgentKnowledgeMetadataConditions](#agentknowledgemetadataconditions) | | No |
|
|
| mode | string, <br>**Available values:** "automatic", "disabled", "manual", <br>**Default:** disabled | *Enum:* `"automatic"`, `"disabled"`, `"manual"` | No |
|
|
| model_config | [AgentKnowledgeModelConfig](#agentknowledgemodelconfig) | | No |
|
|
|
|
#### AgentKnowledgeModelConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | No |
|
|
| mode | string | | Yes |
|
|
| name | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### AgentKnowledgeQueryConfig
|
|
|
|
Per-set query policy for Agent v2 knowledge retrieval.
|
|
|
|
Agent v2 stores knowledge as explicit ``knowledge.sets`` rather than the
|
|
legacy flat ``datasets`` / ``query_mode`` / ``query_config`` shape. Each
|
|
set owns its own query policy. Mode-dependent completeness, such as
|
|
requiring ``value`` for ``user_query``, is enforced by composer publish
|
|
validation so draft saves can persist partially configured knowledge sets.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mode | [AgentKnowledgeQueryMode](#agentknowledgequerymode) | | Yes |
|
|
| value | string | | No |
|
|
|
|
#### AgentKnowledgeQueryMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentKnowledgeQueryMode | string | | |
|
|
|
|
#### AgentKnowledgeRerankingModelConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### AgentKnowledgeRetrievalConfig
|
|
|
|
Per-set retrieval policy for Agent v2 knowledge retrieval.
|
|
|
|
Retrieval settings now live on each knowledge set instead of one shared
|
|
flat config. Mode-dependent completeness, such as requiring ``top_k`` for
|
|
``multiple`` or a model for ``single``, is enforced by composer publish
|
|
validation so draft saves can persist partially configured knowledge sets.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mode | string, <br>**Available values:** "multiple", "single" | *Enum:* `"multiple"`, `"single"` | Yes |
|
|
| model | [AgentKnowledgeModelConfig](#agentknowledgemodelconfig) | | No |
|
|
| reranking_enable | boolean, <br>**Default:** true | | No |
|
|
| reranking_mode | string, <br>**Default:** reranking_model | | No |
|
|
| reranking_model | [AgentKnowledgeRerankingModelConfig](#agentknowledgererankingmodelconfig) | | No |
|
|
| score_threshold | number | | No |
|
|
| top_k | integer | | No |
|
|
| weights | [AgentKnowledgeWeightedScoreConfig](#agentknowledgeweightedscoreconfig) | | No |
|
|
|
|
#### AgentKnowledgeSetConfig
|
|
|
|
One explicit knowledge set in Agent v2.
|
|
|
|
``knowledge.sets`` replaces the old flat knowledge config. Each set owns
|
|
its datasets plus query, retrieval, and metadata policies. An individual
|
|
set must contain at least one dataset id even though the overall knowledge
|
|
section may be empty, which is how callers express "no knowledge layer".
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasets | [ [AgentKnowledgeDatasetConfig](#agentknowledgedatasetconfig) ] | | Yes |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| metadata_filtering | [AgentKnowledgeMetadataFilteringConfig](#agentknowledgemetadatafilteringconfig) | | No |
|
|
| name | string | | Yes |
|
|
| query | [AgentKnowledgeQueryConfig](#agentknowledgequeryconfig) | | Yes |
|
|
| retrieval | [AgentKnowledgeRetrievalConfig](#agentknowledgeretrievalconfig) | | Yes |
|
|
|
|
#### AgentKnowledgeSpaceConfig
|
|
|
|
One read-only Agent Knowledge Base binding, addressed by stable ID or CLI alias.
|
|
|
|
The control-space ID is Dify-owned, never the execution-plane space ID.
|
|
``is_missing`` preserves unresolved DSL references for editing; it never
|
|
authorizes execution. Names/descriptions are author guidance, not authority.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| control_space_id | string | | Yes |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| is_missing | boolean | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### AgentKnowledgeWeightedScoreConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_setting | object | | No |
|
|
| vector_setting | object | | No |
|
|
| weight_type | string | | No |
|
|
|
|
#### AgentLogConversationItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| end_user_id | string | | No |
|
|
| id | string | | Yes |
|
|
| message_count | integer | | Yes |
|
|
| operation_rate | number | | No |
|
|
| source | [AgentLogSourceResponse](#agentlogsourceresponse) | | No |
|
|
| status | string, <br>**Available values:** "failed", "paused", "success" | *Enum:* `"failed"`, `"paused"`, `"success"` | Yes |
|
|
| title | string | | No |
|
|
| unread | boolean | | Yes |
|
|
| updated_at | integer | | No |
|
|
| user_rate | number | | No |
|
|
|
|
#### AgentLogFeedbackResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| from_source | string, <br>**Available values:** "admin", "user" | *Enum:* `"admin"`, `"user"` | Yes |
|
|
| rating | string, <br>**Available values:** "dislike", "like" | *Enum:* `"dislike"`, `"like"` | Yes |
|
|
|
|
#### AgentLogListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentLogConversationItemResponse](#agentlogconversationitemresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AgentLogMessageItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | Yes |
|
|
| answer_tokens | integer | | Yes |
|
|
| conversation_id | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| currency | string | | Yes |
|
|
| error | string | | No |
|
|
| feedback_enabled | boolean | | No |
|
|
| feedbacks | [ [AgentLogFeedbackResponse](#agentlogfeedbackresponse) ] | | No |
|
|
| from_account_id | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| id | string | | Yes |
|
|
| latency | number | | Yes |
|
|
| message_id | string | | Yes |
|
|
| message_tokens | integer | | Yes |
|
|
| query | string | | Yes |
|
|
| status | string | | Yes |
|
|
| total_price | string | | Yes |
|
|
| total_tokens | integer | | Yes |
|
|
| updated_at | integer | | No |
|
|
|
|
#### AgentLogMessageListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentLogMessageItemResponse](#agentlogmessageitemresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AgentLogMetaResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_mode | string | | Yes |
|
|
| elapsed_time | number | | No |
|
|
| executor | string | | Yes |
|
|
| iterations | integer | | Yes |
|
|
| start_time | string | | Yes |
|
|
| status | string | | Yes |
|
|
| total_tokens | integer | | Yes |
|
|
|
|
#### AgentLogResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ ] | | No |
|
|
| iterations | [ [AgentIterationLogResponse](#agentiterationlogresponse) ] | | Yes |
|
|
| meta | [AgentLogMetaResponse](#agentlogmetaresponse) | | Yes |
|
|
|
|
#### AgentLogSourceGroupResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | string | | Yes |
|
|
| sources | [ [AgentLogSourceResponse](#agentlogsourceresponse) ] | | No |
|
|
| type | string, <br>**Available values:** "webapp", "workflow" | *Enum:* `"webapp"`, `"workflow"` | Yes |
|
|
|
|
#### AgentLogSourceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentLogSourceResponse](#agentlogsourceresponse) ] | | Yes |
|
|
| groups | [ [AgentLogSourceGroupResponse](#agentlogsourcegroupresponse) ] | | Yes |
|
|
|
|
#### AgentLogSourceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_icon | string | | No |
|
|
| app_icon_background | string | | No |
|
|
| app_icon_type | string | | No |
|
|
| app_id | string | | Yes |
|
|
| app_name | string | | Yes |
|
|
| id | string | | Yes |
|
|
| node_id | string | | No |
|
|
| type | string, <br>**Available values:** "webapp", "workflow" | *Enum:* `"webapp"`, `"workflow"` | Yes |
|
|
| workflow_id | string | | No |
|
|
| workflow_version | string | | No |
|
|
|
|
#### AgentLogsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| end | string | End date (YYYY-MM-DD HH:MM) | No |
|
|
| keyword | string | Search query, answer, or conversation name | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| sort_by | string, <br>**Default:** updated_at | Sort by created_at or updated_at | No |
|
|
| sort_order | string, <br>**Default:** desc | Sort order: asc or desc | No |
|
|
| source | string | Deprecated single source filter | No |
|
|
| sources | [ string ] | Filter by one or more source IDs, e.g. webapp:<app_id> or workflow:<app_id>. Exact workflow:<app_id>:<workflow_id>:<version>:<node_id> IDs remain supported. | No |
|
|
| start | string | Start date (YYYY-MM-DD HH:MM) | No |
|
|
| status | string | Deprecated single status filter | No |
|
|
| statuses | [ string ] | Filter by one or more of success, failed, paused | No |
|
|
|
|
#### AgentMemoryArtifactConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | No |
|
|
| name | string | | No |
|
|
| type | string | | No |
|
|
| url | string | | No |
|
|
|
|
#### AgentModelNotConfiguredError
|
|
|
|
Agent App requires the Agent Soul model to be configured.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentModelNotConfiguredError | | Agent App requires the Agent Soul model to be configured. | |
|
|
|
|
#### AgentModelResponseFormatConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string | | No |
|
|
|
|
#### AgentModerationIOConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| preset_response | string | | No |
|
|
|
|
#### AgentModerationProviderConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_based_extension_id | string | | No |
|
|
| inputs_config | [AgentModerationIOConfig](#agentmoderationioconfig) | | No |
|
|
| keywords | string | | No |
|
|
| outputs_config | [AgentModerationIOConfig](#agentmoderationioconfig) | | No |
|
|
|
|
#### AgentNameConflictError
|
|
|
|
Agent name already exists.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentNameConflictError | | Agent name already exists. | |
|
|
|
|
#### AgentNotBoundError
|
|
|
|
no agent is bound for this app/node
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentNotBoundError | | no agent is bound for this app/node | |
|
|
|
|
#### AgentNotFoundError
|
|
|
|
Agent not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentNotFoundError | | Agent not found. | |
|
|
|
|
#### AgentNotPublishedError
|
|
|
|
Publish the Agent before enabling Web App or API access.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentNotPublishedError | | Publish the Agent before enabling Web App or API access. | |
|
|
|
|
#### AgentPermissionConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed | boolean | | No |
|
|
| state | string | | No |
|
|
| status | string | | No |
|
|
|
|
#### AgentProviderEntityWithPlugin
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| identity | [AgentStrategyProviderIdentity](#agentstrategyprovideridentity) | | Yes |
|
|
| plugin_id | string | The id of the plugin | No |
|
|
| strategies | [ [AgentStrategyEntity](#agentstrategyentity) ] | | No |
|
|
|
|
#### AgentProviderListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentProviderListResponse | array | | |
|
|
|
|
#### AgentProviderResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| declaration | [AgentProviderEntityWithPlugin](#agentproviderentitywithplugin) | | Yes |
|
|
| meta | [Meta](#meta) | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### AgentPublicationCountsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| drafts | integer | Draft Agent Apps in the current list scope, excluding the publication status filter | Yes |
|
|
| published | integer | Published Agent Apps in the current list scope, excluding the publication status filter | Yes |
|
|
|
|
#### AgentPublishPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| version_note | string | Optional note for this published Agent version | No |
|
|
|
|
#### AgentPublishResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) | | No |
|
|
| active_config_snapshot_id | string | | Yes |
|
|
| draft | [AgentConfigDraftSummaryResponse](#agentconfigdraftsummaryresponse) | | No |
|
|
| publication_kind | string, <br>**Available values:** "first", "update" | Classifies the publication by whether the Agent had a publish-visible active snapshot before publishing: 'first' if none existed, otherwise 'update'. This is not a historical first-publish indicator. It does not depend on draft edits, Web App or API enablement, or the requesting user's access permissions.<br>*Enum:* `"first"`, `"update"` | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### AgentPublishedReferenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_icon | string | | No |
|
|
| app_icon_background | string | | No |
|
|
| app_icon_type | string | | No |
|
|
| app_id | string | | Yes |
|
|
| app_mode | string | | Yes |
|
|
| app_name | string | | Yes |
|
|
| app_updated_at | integer | | No |
|
|
| node_ids | [ string ] | | No |
|
|
| workflow_id | string | | Yes |
|
|
| workflow_version | string | | Yes |
|
|
|
|
#### AgentReferencingWorkflowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_icon | string | | No |
|
|
| app_icon_background | string | | No |
|
|
| app_icon_type | string | | No |
|
|
| app_id | string | | Yes |
|
|
| app_mode | string | | Yes |
|
|
| app_name | string | | Yes |
|
|
| app_updated_at | integer | | No |
|
|
| node_ids | [ string ] | | No |
|
|
| workflow_id | string | | Yes |
|
|
| workflow_version | string | | Yes |
|
|
|
|
#### AgentReferencingWorkflowsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentReferencingWorkflowResponse](#agentreferencingworkflowresponse) ] | | No |
|
|
|
|
#### AgentRosterListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AgentRosterResponse](#agentrosterresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AgentRosterResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_is_published | boolean | | No |
|
|
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) | | No |
|
|
| active_config_snapshot_id | string | | No |
|
|
| agent_kind | [AgentKind](#agentkind) | | Yes |
|
|
| app_id | string | | No |
|
|
| archived_at | integer | | No |
|
|
| archived_by | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| description | string | | Yes |
|
|
| hidden_app_backed | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [AgentIconType](#agenticontype) | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| published_node_reference_count | integer | | No |
|
|
| published_reference_count | integer | | No |
|
|
| published_references | [ [AgentPublishedReferenceResponse](#agentpublishedreferenceresponse) ] | | No |
|
|
| reference_count | integer | | No |
|
|
| role | string | | No |
|
|
| scope | [AgentScope](#agentscope) | | Yes |
|
|
| source | [AgentSource](#agentsource) | | Yes |
|
|
| status | [AgentStatus](#agentstatus) | | Yes |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| workflow_id | string | | No |
|
|
| workflow_node_id | string | | No |
|
|
|
|
#### AgentSandboxDownloadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| caller_id | string | Agent App caller ID | Yes |
|
|
| caller_type | string, <br>**Available values:** "build_draft", "conversation" | *Enum:* `"build_draft"`, `"conversation"` | Yes |
|
|
| path | string | Binding path: relative paths start in Workspace; exact `~` and paths beginning with `~/` start in Home; `~user` is an ordinary relative path from Workspace; absolute paths remain absolute; `..` and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction | Yes |
|
|
|
|
#### AgentSandboxProviderConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cpu | integer | | No |
|
|
| env | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] | | No |
|
|
| image | string | | No |
|
|
| working_dir | string | | No |
|
|
|
|
#### AgentScope
|
|
|
|
Visibility and lifecycle scope of an Agent record.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentScope | string | Visibility and lifecycle scope of an Agent record. | |
|
|
|
|
#### AgentSecretRefConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
| env_name | string | | No |
|
|
| id | string | | No |
|
|
| key | string | | No |
|
|
| name | string | | No |
|
|
| permission | [AgentPermissionConfig](#agentpermissionconfig) | | No |
|
|
| permission_status | string | | No |
|
|
| provider | string | | No |
|
|
| provider_credential_id | string | | No |
|
|
| ref | string | | No |
|
|
| type | string | | No |
|
|
| value | string | | No |
|
|
| variable | string | | No |
|
|
|
|
#### AgentSensitiveWordAvoidanceFeatureConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | [AgentModerationProviderConfig](#agentmoderationproviderconfig) | | No |
|
|
| enabled | boolean | | No |
|
|
| type | string | | No |
|
|
|
|
#### AgentSimpleResultResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | | Yes |
|
|
|
|
#### AgentSkillBindingItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| display_name | string | | Yes |
|
|
| file_count | integer | | Yes |
|
|
| icon | string | | Yes |
|
|
| id | string | | Yes |
|
|
| latest_published_at | integer | | No |
|
|
| latest_published_version_id | string | | No |
|
|
| name | string | | Yes |
|
|
| priority | integer | | Yes |
|
|
| status | string | | Yes |
|
|
| tags | [ string ] | | No |
|
|
| updated_at | integer | | Yes |
|
|
|
|
#### AgentSkillBindingsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| skill_ids | [ string ] | Ordered Skill IDs bound to the Agent. | No |
|
|
|
|
#### AgentSkillBindingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | Yes |
|
|
| data | [ [AgentSkillBindingItemResponse](#agentskillbindingitemresponse) ] | | No |
|
|
| skill_ids | [ string ] | | No |
|
|
|
|
#### AgentSoulAppFeaturesConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_upload | [AgentFileUploadFeatureConfig](#agentfileuploadfeatureconfig) | | No |
|
|
| opening_statement | string | | No |
|
|
| retriever_resource | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) | | No |
|
|
| sensitive_word_avoidance | [AgentSensitiveWordAvoidanceFeatureConfig](#agentsensitivewordavoidancefeatureconfig) | | No |
|
|
| speech_to_text | [AgentFeatureToggleConfig](#agentfeaturetoggleconfig) | | No |
|
|
| suggested_questions | [ string ] | | No |
|
|
| suggested_questions_after_answer | [AgentSuggestedQuestionsAfterAnswerFeatureConfig](#agentsuggestedquestionsafteranswerfeatureconfig) | | No |
|
|
| text_to_speech | [AgentTextToSpeechFeatureConfig](#agenttexttospeechfeatureconfig) | | No |
|
|
|
|
#### AgentSoulConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_features | [AgentSoulAppFeaturesConfig](#agentsoulappfeaturesconfig) | | No |
|
|
| app_variables | [ [AppVariableConfig](#appvariableconfig) ] | | No |
|
|
| config_files | [ [AgentConfigFileRefConfig](#agentconfigfilerefconfig) ] | | No |
|
|
| config_note | string | | No |
|
|
| config_skills | [ [AgentConfigSkillRefConfig](#agentconfigskillrefconfig) ] | | No |
|
|
| env | [AgentSoulEnvConfig](#agentsoulenvconfig) | | No |
|
|
| human | [AgentSoulHumanConfig](#agentsoulhumanconfig) | | No |
|
|
| knowledge | [AgentSoulKnowledgeConfig](#agentsoulknowledgeconfig) | | No |
|
|
| memory | [AgentSoulMemoryConfig](#agentsoulmemoryconfig) | | No |
|
|
| misc_legacy | [AgentSoulAppFeaturesConfig](#agentsoulappfeaturesconfig) | | No |
|
|
| model | [AgentSoulModelConfig](#agentsoulmodelconfig) | | No |
|
|
| prompt | [AgentSoulPromptConfig](#agentsoulpromptconfig) | | No |
|
|
| sandbox | [AgentSoulSandboxConfig](#agentsoulsandboxconfig) | | No |
|
|
| schema_version | integer, <br>**Default:** 1 | | No |
|
|
| tools | [AgentSoulToolsConfig](#agentsoultoolsconfig) | | No |
|
|
|
|
#### AgentSoulDifyToolConfig
|
|
|
|
One Dify tool configured on Agent Soul.
|
|
|
|
The API backend prepares this persisted product shape into
|
|
either ``DifyPluginToolConfig`` or ``DifyCoreToolConfig`` before sending a
|
|
run request to Agent backend. ``plugin`` providers keep the direct
|
|
``dify.plugin.tools`` transport; ``builtin`` / ``api`` / ``workflow`` /
|
|
``mcp`` providers are prepared for ``dify.core.tools``. ``provider_id``
|
|
keeps compatibility with existing Agent tool config payloads; new callers
|
|
should send ``plugin_id`` + ``provider`` when available.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_ref | [AgentSoulDifyToolCredentialRef](#agentsouldifytoolcredentialref) | | No |
|
|
| credential_type | string, <br>**Available values:** "api-key", "oauth2", "unauthorized", <br>**Default:** api-key | *Enum:* `"api-key"`, `"oauth2"`, `"unauthorized"` | No |
|
|
| description | string | | No |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| name | string | | No |
|
|
| plugin_id | string | | No |
|
|
| provider | string | | No |
|
|
| provider_id | string | | No |
|
|
| provider_type | [ToolProviderType](#toolprovidertype) | | Yes |
|
|
| runtime_parameters | object | | No |
|
|
| tool_name | string | | No |
|
|
|
|
#### AgentSoulDifyToolCredentialRef
|
|
|
|
Reference to a stored Dify Plugin Tool credential.
|
|
|
|
Secret values are resolved only at runtime. The legacy ``credential_id``
|
|
field is accepted by :class:`AgentSoulDifyToolConfig` and normalized here so
|
|
old Agent tool payloads can be read while new payloads stay explicit.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | No |
|
|
| provider | string | | No |
|
|
| type | string, <br>**Available values:** "provider", "tool", <br>**Default:** tool | *Enum:* `"provider"`, `"tool"` | No |
|
|
|
|
#### AgentSoulEnvConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| secret_refs | [ [AgentSecretRefConfig](#agentsecretrefconfig) ] | | No |
|
|
| variables | [ [AgentEnvVariableConfig](#agentenvvariableconfig) ] | | No |
|
|
|
|
#### AgentSoulHumanConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] | | No |
|
|
| tools | [ [AgentHumanToolConfig](#agenthumantoolconfig) ] | | No |
|
|
|
|
#### AgentSoulKnowledgeConfig
|
|
|
|
Agent Knowledge Base and Classic Knowledge Base bindings for an Agent.
|
|
|
|
``spaces`` use the KnowledgeFS layer and ``sets`` use the Classic Knowledge
|
|
Base layer. Both may be configured together; empty knowledge adds no runtime
|
|
capability.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| sets | [ [AgentKnowledgeSetConfig](#agentknowledgesetconfig) ] | | No |
|
|
| spaces | [ [AgentKnowledgeSpaceConfig](#agentknowledgespaceconfig) ] | | No |
|
|
|
|
#### AgentSoulLockedError
|
|
|
|
Agent Soul is locked for this workflow node.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentSoulLockedError | | Agent Soul is locked for this workflow node. | |
|
|
|
|
#### AgentSoulMemoryConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| artifacts | [ [AgentMemoryArtifactConfig](#agentmemoryartifactconfig) ] | | No |
|
|
| budget | string | | No |
|
|
| scope | string | | No |
|
|
|
|
#### AgentSoulModelConfig
|
|
|
|
Stable model selection for Agent runtime without storing secret values.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_ref | [AgentSoulModelCredentialRef](#agentsoulmodelcredentialref) | | No |
|
|
| model | string | | Yes |
|
|
| model_provider | string | | Yes |
|
|
| model_settings | [AgentSoulModelSettings](#agentsoulmodelsettings) | | No |
|
|
| plugin_id | string | | Yes |
|
|
|
|
#### AgentSoulModelCredentialRef
|
|
|
|
Reference to model credentials resolved only at runtime.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | No |
|
|
| provider | string | | No |
|
|
| type | string | | Yes |
|
|
|
|
#### AgentSoulModelSettings
|
|
|
|
Model parameters for the Agent Soul model.
|
|
|
|
Model plugins can declare arbitrary parameters via ``parameter_rules``
|
|
(e.g. Qwen/Tongyi's ``enable_thinking``) beyond the common OpenAI-style
|
|
fields typed below, so extra keys must round-trip through persistence
|
|
rather than being dropped.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| frequency_penalty | number | | No |
|
|
| max_tokens | integer | | No |
|
|
| presence_penalty | number | | No |
|
|
| response_format | string<br>[AgentModelResponseFormatConfig](#agentmodelresponseformatconfig) | | No |
|
|
| stop | [ string ] | | No |
|
|
| temperature | number | | No |
|
|
| top_p | number | | No |
|
|
|
|
#### AgentSoulPromptConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| system_prompt | string | | No |
|
|
|
|
#### AgentSoulSandboxConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | [AgentSandboxProviderConfig](#agentsandboxproviderconfig) | | No |
|
|
| provider | string | | No |
|
|
|
|
#### AgentSoulToolsConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cli_tools | [ [AgentCliToolConfig](#agentclitoolconfig) ] | | No |
|
|
| dify_tools | [ [AgentSoulDifyToolConfig](#agentsouldifytoolconfig) ] | | No |
|
|
|
|
#### AgentSource
|
|
|
|
Origin that created or imported the Agent.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentSource | string | Origin that created or imported the Agent. | |
|
|
|
|
#### AgentStatisticChartsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| average_response_time | [ [AgentAverageResponseTimeStatisticResponse](#agentaverageresponsetimestatisticresponse) ] | | No |
|
|
| average_session_interactions | [ [AgentAverageSessionInteractionStatisticResponse](#agentaveragesessioninteractionstatisticresponse) ] | | No |
|
|
| daily_conversations | [ [AgentDailyConversationStatisticResponse](#agentdailyconversationstatisticresponse) ] | | No |
|
|
| daily_end_users | [ [AgentDailyEndUserStatisticResponse](#agentdailyenduserstatisticresponse) ] | | No |
|
|
| daily_messages | [ [AgentDailyMessageStatisticResponse](#agentdailymessagestatisticresponse) ] | | No |
|
|
| token_usage | [ [AgentTokenUsageStatisticResponse](#agenttokenusagestatisticresponse) ] | | No |
|
|
| tokens_per_second | [ [AgentTokensPerSecondStatisticResponse](#agenttokenspersecondstatisticresponse) ] | | No |
|
|
| user_satisfaction_rate | [ [AgentUserSatisfactionRateStatisticResponse](#agentusersatisfactionratestatisticresponse) ] | | No |
|
|
|
|
#### AgentStatisticSummaryEnvelopeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| charts | [AgentStatisticChartsResponse](#agentstatisticchartsresponse) | | Yes |
|
|
| source | string | | Yes |
|
|
| summary | [AgentStatisticSummaryResponse](#agentstatisticsummaryresponse) | | Yes |
|
|
|
|
#### AgentStatisticSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| average_response_time | number | | Yes |
|
|
| average_session_interactions | number | | Yes |
|
|
| currency | string | | Yes |
|
|
| tokens_per_second | number | | Yes |
|
|
| total_conversations | integer | | Yes |
|
|
| total_end_users | integer | | Yes |
|
|
| total_messages | integer | | Yes |
|
|
| total_price | string | | Yes |
|
|
| total_tokens | integer | | Yes |
|
|
| user_satisfaction_rate | number | | Yes |
|
|
|
|
#### AgentStatisticsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| end | string | End date (YYYY-MM-DD HH:MM) | No |
|
|
| source | string | Filter by a structured webapp:<app_id> or workflow:<app_id> source ID. Legacy invoke sources and exact workflow version/node source IDs remain supported. | No |
|
|
| start | string | Start date (YYYY-MM-DD HH:MM) | No |
|
|
|
|
#### AgentStatus
|
|
|
|
Soft lifecycle state for Agent records.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentStatus | string | Soft lifecycle state for Agent records. | |
|
|
|
|
#### AgentStrategyEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | [I18nObject](#i18nobject) | The description of the agent strategy | Yes |
|
|
| features | [ [AgentFeature](#agentfeature) ] | | No |
|
|
| identity | [AgentStrategyIdentity](#agentstrategyidentity) | | Yes |
|
|
| meta_version | string | | No |
|
|
| output_schema | object | | No |
|
|
| parameters | [ [AgentStrategyParameter](#agentstrategyparameter) ] | | No |
|
|
|
|
#### AgentStrategyIdentity
|
|
|
|
Inherits from ToolIdentity, without any additional fields.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the tool | Yes |
|
|
| icon | string | | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the tool | Yes |
|
|
| name | string | The name of the tool | Yes |
|
|
| provider | string | The provider of the tool | Yes |
|
|
|
|
#### AgentStrategyParameter
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_generate | [PluginParameterAutoGenerate](#pluginparameterautogenerate) | | No |
|
|
| default | number<br>integer<br>string<br>boolean<br>[ object ]<br>object | | No |
|
|
| help | [I18nObject](#i18nobject) | | No |
|
|
| label | [I18nObject](#i18nobject) | The label presented to the user | Yes |
|
|
| max | number<br>integer | | No |
|
|
| min | number<br>integer | | No |
|
|
| name | string | The name of the parameter | Yes |
|
|
| options | [ [PluginParameterOption](#pluginparameteroption) ] | | No |
|
|
| placeholder | [I18nObject](#i18nobject) | The placeholder presented to the user | No |
|
|
| precision | integer | | No |
|
|
| required | boolean | | No |
|
|
| scope | string | | No |
|
|
| template | [PluginParameterTemplate](#pluginparametertemplate) | | No |
|
|
| type | [AgentStrategyParameterType](#agentstrategyparametertype) | The type of the parameter | Yes |
|
|
|
|
#### AgentStrategyParameterType
|
|
|
|
Keep all the types from PluginParameterType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentStrategyParameterType | string | Keep all the types from PluginParameterType | |
|
|
|
|
#### AgentStrategyProviderEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| identity | [AgentStrategyProviderIdentity](#agentstrategyprovideridentity) | | Yes |
|
|
| plugin_id | string | The id of the plugin | No |
|
|
|
|
#### AgentStrategyProviderIdentity
|
|
|
|
Inherits from ToolProviderIdentity, without any additional fields.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the tool | Yes |
|
|
| description | [I18nObject](#i18nobject) | The description of the tool | Yes |
|
|
| icon | string | The icon of the tool | Yes |
|
|
| icon_dark | string | The dark icon of the tool | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the tool | Yes |
|
|
| name | string | The name of the tool | Yes |
|
|
| tags | [ [ToolLabelEnum](#toollabelenum) ] | The tags of the tool | No |
|
|
|
|
#### AgentSuggestedQuestionsAfterAnswerFeatureConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| model | [AgentSuggestedQuestionsAfterAnswerModelConfig](#agentsuggestedquestionsafteranswermodelconfig) | | No |
|
|
| prompt | string | | No |
|
|
|
|
#### AgentSuggestedQuestionsAfterAnswerModelConfig
|
|
|
|
Legacy Chat App model config used only for follow-up question generation.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | No |
|
|
| mode | string | | No |
|
|
| name | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### AgentTextToSpeechFeatureConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| autoPlay | string, <br>**Available values:** "disabled", "enabled" | | No |
|
|
| enabled | boolean | | No |
|
|
| language | string | | No |
|
|
| voice | string | | No |
|
|
|
|
#### AgentThought
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | No |
|
|
| chain_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| files | [ string ] | | Yes |
|
|
| id | string | | Yes |
|
|
| message_id | string | | Yes |
|
|
| observation | string | | No |
|
|
| position | integer | | Yes |
|
|
| thought | string | | No |
|
|
| tool | string | | No |
|
|
| tool_input | string | | No |
|
|
| tool_labels | [AnyJSONValue](#anyjsonvalue) | Labels for tools used. | Yes |
|
|
|
|
#### AgentTokenUsageStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| currency | string | | Yes |
|
|
| date | string | | Yes |
|
|
| token_count | integer | | Yes |
|
|
| total_price | string | | Yes |
|
|
|
|
#### AgentTokensPerSecondStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| tps | number | | Yes |
|
|
|
|
#### AgentToolCallResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | No |
|
|
| status | string | | Yes |
|
|
| time_cost | number<br>integer | | Yes |
|
|
| tool_icon | string<br>object | Icon URL or emoji icon | No |
|
|
| tool_input | object | | Yes |
|
|
| tool_label | string<br>object | Tool name or its i18n labels keyed by locale | Yes |
|
|
| tool_name | string | | Yes |
|
|
| tool_output | object | | Yes |
|
|
| tool_parameters | object | | Yes |
|
|
|
|
#### AgentUserSatisfactionRateStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| rate | number | | Yes |
|
|
|
|
#### AgentVersionConflictError
|
|
|
|
Agent config version changed. Please reload and try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentVersionConflictError | | Agent config version changed. Please reload and try again. | |
|
|
|
|
#### AgentVersionNotFoundError
|
|
|
|
Agent config version not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AgentVersionNotFoundError | | Agent config version not found. | |
|
|
|
|
#### AllWorkspaceContacts
|
|
|
|
Migration marker preserving legacy whole-workspace recipient intent.
|
|
|
|
Runtime expansion is deliberately owned by the recipient resolver rather
|
|
than the node-data migration helper.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Default:** all_workspace_contacts | | No |
|
|
|
|
#### AllowedExtensionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_extensions | [ string ] | | Yes |
|
|
|
|
#### AlreadyActivateError
|
|
|
|
Auth Token is invalid or account already activated, please check again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AlreadyActivateError | | Auth Token is invalid or account already activated, please check again. | |
|
|
|
|
#### AlreadySubmittedError
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AlreadySubmittedError | | | |
|
|
|
|
#### Annotation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | No |
|
|
| created_at | integer | | No |
|
|
| hit_count | integer | | No |
|
|
| id | string (uuid) | | Yes |
|
|
| question | string | | No |
|
|
|
|
#### AnnotationBatchImportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error_msg | string | | No |
|
|
| job_id | string | | No |
|
|
| job_status | string | | No |
|
|
| record_count | integer | | No |
|
|
|
|
#### AnnotationCountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer | Number of annotations | Yes |
|
|
|
|
#### AnnotationExportList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [Annotation](#annotation) ] | | Yes |
|
|
|
|
#### AnnotationFilePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message_id | string | Message ID | Yes |
|
|
|
|
#### AnnotationHitHistory
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| match | string | | No |
|
|
| question | string | | No |
|
|
| response | string | | No |
|
|
| score | number | | No |
|
|
| source | string | | No |
|
|
|
|
#### AnnotationHitHistoryList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AnnotationHitHistory](#annotationhithistory) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AnnotationHitHistoryListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 20 | Page size | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
|
|
#### AnnotationJobStatusDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error_msg | string | | No |
|
|
| job_id | string (uuid) | | Yes |
|
|
| job_status | string | | Yes |
|
|
|
|
#### AnnotationJobStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| job_id | string (uuid) | | Yes |
|
|
| job_status | string | | Yes |
|
|
|
|
#### AnnotationList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [Annotation](#annotation) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AnnotationListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Search keyword | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
|
|
#### AnnotationReplyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | Embedding model name | Yes |
|
|
| embedding_provider_name | string | Embedding provider name | Yes |
|
|
| score_threshold | number | Score threshold for annotation matching | Yes |
|
|
|
|
#### AnnotationReplyStatusQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string, <br>**Available values:** "disable", "enable" | *Enum:* `"disable"`, `"enable"` | Yes |
|
|
|
|
#### AnnotationSettingEmbeddingModelResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | | No |
|
|
| embedding_provider_name | string | | No |
|
|
|
|
#### AnnotationSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model | [AnnotationSettingEmbeddingModelResponse](#annotationsettingembeddingmodelresponse) | | No |
|
|
| enabled | boolean | | Yes |
|
|
| id | string | | No |
|
|
| score_threshold | number | | No |
|
|
|
|
#### AnnotationSettingUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| score_threshold | number | Score threshold | Yes |
|
|
|
|
#### AnyJSONValue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AnyJSONValue | | | |
|
|
|
|
#### ApiBaseUrlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_base_url | string | | Yes |
|
|
|
|
#### ApiKeyAuthBindingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | string | | Yes |
|
|
| credentials | [ApiKeyAuthCredentialsPayload](#apikeyauthcredentialspayload) | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### ApiKeyAuthConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_key | string | | Yes |
|
|
|
|
#### ApiKeyAuthCredentialsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auth_type | string | | Yes |
|
|
| config | [ApiKeyAuthConfigPayload](#apikeyauthconfigpayload) | | Yes |
|
|
|
|
#### ApiKeyAuthDataSourceItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| disabled | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
|
|
#### ApiKeyAuthDataSourceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| sources | [ [ApiKeyAuthDataSourceItem](#apikeyauthdatasourceitem) ] | | Yes |
|
|
|
|
#### ApiKeyItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| dataset_ids | [ string ], <br>**Default:** | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_ids | [ string ], <br>**Default:** | | No |
|
|
| last_used_at | integer | | No |
|
|
| token | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### ApiKeyList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ApiKeyItem](#apikeyitem) ] | | Yes |
|
|
|
|
#### ApiProviderDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | No |
|
|
| custom_disclaimer | string | | No |
|
|
| description | string | | No |
|
|
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| privacy_policy | string | | No |
|
|
| schema | string | | Yes |
|
|
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
|
|
| tools | [ [ApiToolBundle](#apitoolbundle) ] | | Yes |
|
|
|
|
#### ApiProviderRemoteSchemaResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| schema | string | | Yes |
|
|
|
|
#### ApiProviderSchemaType
|
|
|
|
Enum class for api provider schema type.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ApiProviderSchemaType | string | Enum class for api provider schema type. | |
|
|
|
|
#### ApiSchemaParseResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
|
|
| parameters_schema | [ [ApiToolBundle](#apitoolbundle) ] | | Yes |
|
|
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
|
|
| warning | object | | Yes |
|
|
|
|
#### ApiToolBundle
|
|
|
|
This class is used to store the schema information of an api based tool.
|
|
such as the url, the method, the parameters, etc.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | | Yes |
|
|
| icon | string | | No |
|
|
| method | string | | Yes |
|
|
| openapi | object | | Yes |
|
|
| operation_id | string | | No |
|
|
| output_schema | object | | No |
|
|
| parameters | [ [ToolParameter](#toolparameter) ] | | No |
|
|
| server_url | string | | Yes |
|
|
| summary | string | | No |
|
|
|
|
#### ApiToolPreviewResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ApiToolPreviewResponse | | | |
|
|
|
|
#### ApiToolPreviewResult
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | No |
|
|
| result | string | | No |
|
|
|
|
#### ApiToolProviderAddPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| custom_disclaimer | string | | No |
|
|
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| privacy_policy | string | | No |
|
|
| provider | string | | Yes |
|
|
| schema | string | | Yes |
|
|
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
|
|
|
|
#### ApiToolProviderDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| provider | string | | Yes |
|
|
|
|
#### ApiToolProviderUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| custom_disclaimer | string | | No |
|
|
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| original_provider | string | | Yes |
|
|
| privacy_policy | string | | No |
|
|
| provider | string | | Yes |
|
|
| schema | string | | Yes |
|
|
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
|
|
|
|
#### ApiToolSchemaPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| schema | string | | Yes |
|
|
|
|
#### ApiToolTestPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| parameters | object | | Yes |
|
|
| provider_name | string | | No |
|
|
| schema | string | | Yes |
|
|
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
|
|
| tool_name | string | | Yes |
|
|
|
|
#### AppAccessMatrix
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | No |
|
|
| items | [ [AccessMatrixItem](#accessmatrixitem) ] | | No |
|
|
|
|
#### AppAgentModePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| max_iteration | integer | | No |
|
|
| prompt | [AppAgentPromptPayload](#appagentpromptpayload)<br>string | | No |
|
|
| strategy | [PlanningStrategy](#planningstrategy)<br>string, <br>**Available values:** "", "cot", "function-calling" | | No |
|
|
| tools | [ [AppAgentToolPayload](#appagenttoolpayload) ] | | No |
|
|
|
|
#### AppAgentModeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| max_iteration | integer | | No |
|
|
| prompt | [AppAgentPromptResponse](#appagentpromptresponse)<br>string | | No |
|
|
| strategy | [PlanningStrategy](#planningstrategy)<br>string, <br>**Available values:** "cot", "function-calling" | | No |
|
|
| tools | [ [AppProviderAgentToolResponse](#appprovideragenttoolresponse)<br>[AppLegacyDatasetToolResponse](#applegacydatasettoolresponse)<br>[AppLegacyGoogleSearchToolResponse](#applegacygooglesearchtoolresponse)<br>[AppLegacyWebReaderToolResponse](#applegacywebreadertoolresponse)<br>[AppLegacyWikipediaToolResponse](#applegacywikipediatoolresponse)<br>[AppLegacyCurrentDatetimeToolResponse](#applegacycurrentdatetimetoolresponse)<br>[AppLegacySensitiveWordToolResponseItem](#applegacysensitivewordtoolresponseitem) ] | | No |
|
|
|
|
#### AppAgentPromptPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| first_prompt | string | | No |
|
|
| next_iteration | string | | No |
|
|
|
|
#### AppAgentPromptResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| first_prompt | string | | No |
|
|
| next_iteration | string | | No |
|
|
|
|
#### AppAgentToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppAgentToolPayload | [AppProviderAgentToolPayload](#appprovideragenttoolpayload)<br>[AppLegacyDatasetToolPayload](#applegacydatasettoolpayload)<br>[AppLegacyGoogleSearchToolPayload](#applegacygooglesearchtoolpayload)<br>[AppLegacyWebReaderToolPayload](#applegacywebreadertoolpayload)<br>[AppLegacyWikipediaToolPayload](#applegacywikipediatoolpayload)<br>[AppLegacyCurrentDatetimeToolPayload](#applegacycurrentdatetimetoolpayload)<br>[AppLegacySensitiveWordToolPayload](#applegacysensitivewordtoolpayload) | | |
|
|
|
|
#### AppAnnotationReplyDisabledResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
|
|
#### AppAnnotationReplyEnabledResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model | [AppEmbeddingModelResponse](#appembeddingmodelresponse) | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| score_threshold | number | | Yes |
|
|
|
|
#### AppApiStatusPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enable_api | boolean | Enable or disable API | Yes |
|
|
|
|
#### AppChatPromptConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| prompt | [ [AppChatPromptMessageResponse](#appchatpromptmessageresponse) ] | | No |
|
|
|
|
#### AppChatPromptMessageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| role | string | | Yes |
|
|
| text | string | | Yes |
|
|
|
|
#### AppChatPromptPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| prompt | [ [AppPromptMessagePayload](#apppromptmessagepayload) ] | | No |
|
|
|
|
#### AppCheckboxFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checkbox | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppCheckboxInputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checkbox | [AppInputFieldPayload](#appinputfieldpayload) | | Yes |
|
|
|
|
#### AppCompletionPromptConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_histories_role | [AppConversationHistoriesRoleResponse](#appconversationhistoriesroleresponse) | | No |
|
|
| prompt | [AppCompletionPromptTextResponse](#appcompletionprompttextresponse) | | No |
|
|
|
|
#### AppCompletionPromptPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_histories_role | [AppConversationRolesPayload](#appconversationrolespayload) | | No |
|
|
| prompt | [AppCompletionPromptTextPayload](#appcompletionprompttextpayload) | | No |
|
|
|
|
#### AppCompletionPromptTextPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text | string | | Yes |
|
|
|
|
#### AppCompletionPromptTextResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text | string | | Yes |
|
|
|
|
#### AppConfigJsonValue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppConfigJsonValue | string<br>integer<br>number<br>boolean<br>[ [AppConfigJsonValue](#appconfigjsonvalue) ]<br>object | | |
|
|
|
|
#### AppConversationHistoriesRoleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| assistant_prefix | string | | Yes |
|
|
| user_prefix | string | | Yes |
|
|
|
|
#### AppConversationRolesPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| assistant_prefix | string | | Yes |
|
|
| user_prefix | string | | Yes |
|
|
|
|
#### AppDatasetCollectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasets | [ [AppDatasetToolPayload](#appdatasettoolpayload) ] | | Yes |
|
|
| strategy | string | | No |
|
|
|
|
#### AppDatasetConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasets | [AppDatasetCollectionPayload](#appdatasetcollectionpayload)<br>[AppEmptyDatasetCollectionPayload](#appemptydatasetcollectionpayload) | | No |
|
|
| metadata_filtering_conditions | [AppMetadataFilteringPayload](#appmetadatafilteringpayload) | | No |
|
|
| metadata_filtering_mode | string, <br>**Available values:** "automatic", "disabled", "manual" | *Enum:* `"automatic"`, `"disabled"`, `"manual"` | No |
|
|
| metadata_model_config | [AppMetadataModelPayload](#appmetadatamodelpayload) | | No |
|
|
| reranking_enable | boolean | | No |
|
|
| reranking_enabled | boolean | | No |
|
|
| reranking_mode | [RerankMode](#rerankmode) | | No |
|
|
| reranking_model | [AppRerankingModelPayload](#apprerankingmodelpayload) | | No |
|
|
| retrieval_model | string, <br>**Available values:** "multiple", "single" | *Enum:* `"multiple"`, `"single"` | No |
|
|
| score_threshold | number | | No |
|
|
| score_threshold_enabled | boolean | | No |
|
|
| top_k | integer | | No |
|
|
| weights | [AppRetrievalWeightsPayload](#appretrievalweightspayload) | | No |
|
|
|
|
#### AppDatasetConfigsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasets | [AppDatasetListResponse](#appdatasetlistresponse) | | No |
|
|
| metadata_filtering_conditions | [AppMetadataFilteringConditionsResponse](#appmetadatafilteringconditionsresponse) | | No |
|
|
| metadata_filtering_mode | string, <br>**Available values:** "automatic", "disabled", "manual" | *Enum:* `"automatic"`, `"disabled"`, `"manual"` | No |
|
|
| metadata_model_config | [AppModelSelectionResponse](#appmodelselectionresponse) | | No |
|
|
| reranking_enable | boolean | | No |
|
|
| reranking_enabled | boolean | | No |
|
|
| reranking_mode | [RerankMode](#rerankmode) | | No |
|
|
| reranking_model | [AppRerankingModelResponse](#apprerankingmodelresponse) | | No |
|
|
| retrieval_model | string, <br>**Available values:** "multiple", "single" | *Enum:* `"multiple"`, `"single"` | Yes |
|
|
| score_threshold | number | | No |
|
|
| score_threshold_enabled | boolean | | No |
|
|
| top_k | integer | | No |
|
|
| weights | [AppWeightsResponse](#appweightsresponse) | | No |
|
|
|
|
#### AppDatasetItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset | [AppDatasetReferenceResponse](#appdatasetreferenceresponse) | | Yes |
|
|
|
|
#### AppDatasetListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasets | [ [AppDatasetItemResponse](#appdatasetitemresponse) ] | | Yes |
|
|
| strategy | string | | No |
|
|
|
|
#### AppDatasetReferenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| id | string | | No |
|
|
|
|
#### AppDatasetSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| id | string | | No |
|
|
|
|
#### AppDatasetToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset | [AppDatasetSelectionPayload](#appdatasetselectionpayload) | | Yes |
|
|
|
|
#### AppDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_mode | [WebAppAccessMode](#webappaccessmode) | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| description | string | | Yes |
|
|
| enable_api | boolean | | Yes |
|
|
| enable_site | boolean | | Yes |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | Yes |
|
|
| id | string | | Yes |
|
|
| maintainer | string | | Yes |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| model_config | [AppModelConfigResponse](#appmodelconfigresponse) | | Yes |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | Yes |
|
|
| tags | [ [Tag](#tag) ] | | Yes |
|
|
| tracing | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
| workflow | [WorkflowPartial](#workflowpartial) | | Yes |
|
|
|
|
#### AppDetailSiteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_token | string | | Yes |
|
|
| app_base_url | string | | Yes |
|
|
| chat_color_theme | string | | Yes |
|
|
| chat_color_theme_inverted | boolean | | Yes |
|
|
| code | string | | Yes |
|
|
| copyright | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| custom_disclaimer | string | | Yes |
|
|
| customize_domain | string | | Yes |
|
|
| customize_token_strategy | [CustomizeTokenStrategy](#customizetokenstrategy) | | Yes |
|
|
| default_language | string | | Yes |
|
|
| description | string | | Yes |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | Yes |
|
|
| icon_type | [IconType](#icontype) | | Yes |
|
|
| icon_url | string | | Yes |
|
|
| input_placeholder | string | | Yes |
|
|
| privacy_policy | string | | Yes |
|
|
| prompt_public | boolean | | Yes |
|
|
| show_workflow_steps | boolean | | Yes |
|
|
| title | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
|
|
#### AppDetailWithSite
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_mode | [WebAppAccessMode](#webappaccessmode) | | Yes |
|
|
| api_base_url | string | | Yes |
|
|
| app_id | string | | Yes |
|
|
| bound_agent_id | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| deleted_tools | [ [DeletedTool](#deletedtool) ] | | Yes |
|
|
| description | string | | Yes |
|
|
| enable_api | boolean | | Yes |
|
|
| enable_site | boolean | | Yes |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | Yes |
|
|
| icon_type | [IconType](#icontype) | | Yes |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| maintainer | string | | Yes |
|
|
| max_active_requests | integer | | Yes |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| model_config | [AppModelConfigResponse](#appmodelconfigresponse) | | Yes |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | Yes |
|
|
| site | [AppDetailSiteResponse](#appdetailsiteresponse) | | Yes |
|
|
| tags | [ [Tag](#tag) ] | | Yes |
|
|
| tracing | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
| workflow | [WorkflowPartial](#workflowpartial) | | Yes |
|
|
|
|
#### AppDisabledExternalDataToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | No |
|
|
| enabled | boolean | | Yes |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| label | string | | No |
|
|
| type | string | | No |
|
|
| variable | string | | No |
|
|
|
|
#### AppDslVersionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_dsl_version | string | | Yes |
|
|
|
|
#### AppEmbeddingModelResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | | Yes |
|
|
| embedding_provider_name | string | | Yes |
|
|
|
|
#### AppEmptyDatasetCollectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
|
|
#### AppEnabledConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
|
|
#### AppEnabledExternalDataToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| label | string | | No |
|
|
| type | string | | Yes |
|
|
| variable | string | | Yes |
|
|
|
|
#### AppExportQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| format | string, <br>**Available values:** "ifpkg", "yaml" | Export format; defaults to ifpkg for all Apps | No |
|
|
| include_secret | boolean | Include secrets in export | No |
|
|
| version_id | string | Published Agent version ID to export; requires a paid plan on Cloud. If omitted, exports the shared draft, falling back to the active snapshot when no draft exists. | No |
|
|
| workflow_id | string | Specific workflow ID to export | No |
|
|
|
|
#### AppExportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | string | | Yes |
|
|
|
|
#### AppExternalDataInputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| external_data_tool | [AppInputFieldPayload](#appinputfieldpayload) | | Yes |
|
|
|
|
#### AppExternalDataToolFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| external_data_tool | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppExternalDataToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | No |
|
|
| enabled | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| label | string | | No |
|
|
| type | string | | No |
|
|
| variable | string | | No |
|
|
|
|
#### AppFeaturePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
|
|
#### AppFileFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppFileListFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file-list | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppFilePreviewPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_type_list | [ string ] | | No |
|
|
| mode | string | | No |
|
|
|
|
#### AppFileTypeUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| number_limits | integer | | No |
|
|
| transfer_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
|
|
#### AppFileUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | No |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
| audio | [AppFileTypeUploadPayload](#appfiletypeuploadpayload) | | No |
|
|
| custom | [AppFileTypeUploadPayload](#appfiletypeuploadpayload) | | No |
|
|
| document | [AppFileTypeUploadPayload](#appfiletypeuploadpayload) | | No |
|
|
| enabled | boolean | | No |
|
|
| image | [AppImageUploadPayload](#appimageuploadpayload) | | No |
|
|
| image_config | [AppImageConfigPayload](#appimageconfigpayload) | | No |
|
|
| number_limits | integer | | No |
|
|
| preview_config | [AppFilePreviewPayload](#appfilepreviewpayload) | | No |
|
|
| video | [AppFileTypeUploadPayload](#appfiletypeuploadpayload) | | No |
|
|
|
|
#### AppFileUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | No |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
| enabled | boolean | | No |
|
|
| image | [AppImageUploadResponse](#appimageuploadresponse) | | No |
|
|
| number_limits | integer | | No |
|
|
|
|
#### AppIconPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | Icon data | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
|
|
#### AppImageConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| detail | string, <br>**Available values:** "high", "low" | | No |
|
|
| number_limits | integer | | No |
|
|
| transfer_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
|
|
#### AppImageUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| detail | string, <br>**Available values:** "high", "low" | | No |
|
|
| enabled | boolean | | No |
|
|
| number_limits | integer | | No |
|
|
| transfer_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
|
|
#### AppImageUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| detail | string, <br>**Available values:** "high", "low" | | No |
|
|
| enabled | boolean | | No |
|
|
| number_limits | integer | | No |
|
|
| transfer_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
|
|
#### AppImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | No |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| mode | string | Import mode | Yes |
|
|
| name | string | | No |
|
|
| package_url | string | | No |
|
|
| template_id | string | | No |
|
|
| version_id | string | | No |
|
|
| yaml_content | string | | No |
|
|
| yaml_url | string | | No |
|
|
|
|
#### AppImportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | No |
|
|
| app_mode | [AppMode](#appmode) | | No |
|
|
| current_dsl_version | string | | Yes |
|
|
| error | string | | No |
|
|
| id | string | | Yes |
|
|
| imported_dsl_version | string | | No |
|
|
| status | [ImportStatus](#importstatus) | | Yes |
|
|
| warnings | [ [DslImportWarning](#dslimportwarning) ] | | No |
|
|
|
|
#### AppInputFieldPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | No |
|
|
| default | [AppConfigJsonValue](#appconfigjsonvalue) | | No |
|
|
| description | string | | No |
|
|
| enabled | boolean | | No |
|
|
| hide | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| json_schema | string<br>object | | No |
|
|
| label | string | | Yes |
|
|
| max_length | integer | | No |
|
|
| options | [ string ] | | No |
|
|
| required | boolean | | No |
|
|
| type | string | | No |
|
|
| variable | string | | Yes |
|
|
|
|
#### AppJsonObjectFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| json_object | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppKeywordSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_weight | number | | Yes |
|
|
|
|
#### AppKeywordWeightPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_weight | number | | Yes |
|
|
|
|
#### AppLegacyCurrentDatetimeToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_datetime | [AppFeaturePayload](#appfeaturepayload) | | Yes |
|
|
|
|
#### AppLegacyCurrentDatetimeToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_datetime | object | | Yes |
|
|
|
|
#### AppLegacyDatasetSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| id | string | | No |
|
|
|
|
#### AppLegacyDatasetToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset | [AppLegacyDatasetSelectionPayload](#applegacydatasetselectionpayload) | | Yes |
|
|
|
|
#### AppLegacyDatasetToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset | [AppDatasetReferenceResponse](#appdatasetreferenceresponse) | | Yes |
|
|
|
|
#### AppLegacyGoogleSearchToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| google_search | [AppFeaturePayload](#appfeaturepayload) | | Yes |
|
|
|
|
#### AppLegacyGoogleSearchToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| google_search | object | | Yes |
|
|
|
|
#### AppLegacySensitiveWordConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| canned_response | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| words | [ string ] | | Yes |
|
|
|
|
#### AppLegacySensitiveWordToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| sensitive-word-avoidance | [AppLegacySensitiveWordConfigPayload](#applegacysensitivewordconfigpayload) | | Yes |
|
|
|
|
#### AppLegacySensitiveWordToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| canned_response | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| words | [ string ] | | Yes |
|
|
|
|
#### AppLegacySensitiveWordToolResponseItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| sensitive-word-avoidance | [AppLegacySensitiveWordToolResponse](#applegacysensitivewordtoolresponse) | | Yes |
|
|
|
|
#### AppLegacyWebReaderToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| web_reader | [AppFeaturePayload](#appfeaturepayload) | | Yes |
|
|
|
|
#### AppLegacyWebReaderToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| web_reader | object | | Yes |
|
|
|
|
#### AppLegacyWikipediaToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| wikipedia | [AppFeaturePayload](#appfeaturepayload) | | Yes |
|
|
|
|
#### AppLegacyWikipediaToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| wikipedia | object | | Yes |
|
|
|
|
#### AppListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| creator_ids | [ string ] | Filter by creator account IDs | No |
|
|
| is_created_by_me | boolean | Filter by creator | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all | App mode filter<br>*Enum:* `"advanced-chat"`, `"agent"`, `"agent-chat"`, `"all"`, `"channel"`, `"chat"`, `"completion"`, `"workflow"` | No |
|
|
| name | string | Filter by app name | No |
|
|
| openapi_visible | boolean | Only return apps with API access enabled | No |
|
|
| page | integer, <br>**Default:** 1 | Page number (1-99999) | No |
|
|
| sort_by | string, <br>**Available values:** "earliest_created", "last_modified", "recently_created", <br>**Default:** last_modified | Sort apps by last modified, recently created, or earliest created<br>*Enum:* `"earliest_created"`, `"last_modified"`, `"recently_created"` | No |
|
|
| tag_ids | [ string ] | Filter by tag IDs | No |
|
|
|
|
#### AppMCPServerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| description | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| parameters | object<br>[ object ]<br>string | | Yes |
|
|
| server_code | string | | Yes |
|
|
| status | [AppMCPServerStatus](#appmcpserverstatus) | | Yes |
|
|
| updated_at | integer | | No |
|
|
|
|
#### AppMCPServerStatus
|
|
|
|
Publication state of a Dify app exposed as an MCP server; only ACTIVE servers accept MCP calls.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppMCPServerStatus | string | Publication state of a Dify app exposed as an MCP server; only ACTIVE servers accept MCP calls. | |
|
|
|
|
#### AppMessageFeedbackPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Optional text feedback providing additional detail. | No |
|
|
| message_id | string | Message ID | Yes |
|
|
| rating | string, <br>**Available values:** "dislike", "like" | Feedback rating. Set to `null` to revoke previously submitted feedback. | No |
|
|
|
|
#### AppMetadataConditionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| comparison_operator | string, <br>**Available values:** "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" | *Enum:* `"<"`, `"="`, `">"`, `"after"`, `"before"`, `"contains"`, `"empty"`, `"end with"`, `"in"`, `"is"`, `"is not"`, `"not contains"`, `"not empty"`, `"not in"`, `"start with"`, `"≠"`, `"≤"`, `"≥"` | Yes |
|
|
| id | string | | No |
|
|
| metadata_id | string | | No |
|
|
| name | string | | Yes |
|
|
| value | string<br>[ string ]<br>integer<br>number | | No |
|
|
|
|
#### AppMetadataConditionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| comparison_operator | string, <br>**Available values:** "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" | *Enum:* `"<"`, `"="`, `">"`, `"after"`, `"before"`, `"contains"`, `"empty"`, `"end with"`, `"in"`, `"is"`, `"is not"`, `"not contains"`, `"not empty"`, `"not in"`, `"start with"`, `"≠"`, `"≤"`, `"≥"` | Yes |
|
|
| id | string | | No |
|
|
| metadata_id | string | | No |
|
|
| name | string | | Yes |
|
|
| value | string<br>[ string ]<br>integer<br>number | | No |
|
|
|
|
#### AppMetadataFilteringConditionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conditions | [ [AppMetadataConditionResponse](#appmetadataconditionresponse) ] | | No |
|
|
| logical_operator | string, <br>**Available values:** "and", "or" | | No |
|
|
|
|
#### AppMetadataFilteringPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conditions | [ [AppMetadataConditionPayload](#appmetadataconditionpayload) ] | | No |
|
|
| logical_operator | string, <br>**Available values:** "and", "or" | | No |
|
|
|
|
#### AppMetadataModelPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | No |
|
|
| mode | [LLMMode](#llmmode)<br>string | | No |
|
|
| name | string | | No |
|
|
| provider | string | | No |
|
|
|
|
#### AppMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppMode | string | | |
|
|
|
|
#### AppModelConfigPayload
|
|
|
|
Write transport; app-mode validators own defaults and feature-specific rules.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_mode | [AppAgentModePayload](#appagentmodepayload) | | No |
|
|
| chat_prompt_config | [AppChatPromptPayload](#appchatpromptpayload) | | No |
|
|
| completion_prompt_config | [AppCompletionPromptPayload](#appcompletionpromptpayload) | | No |
|
|
| dataset_configs | [AppDatasetConfigPayload](#appdatasetconfigpayload) | | No |
|
|
| dataset_query_variable | string | | No |
|
|
| external_data_tools | [ [AppExternalDataToolPayload](#appexternaldatatoolpayload) ] | | No |
|
|
| file_upload | [AppFileUploadPayload](#appfileuploadpayload) | | No |
|
|
| model | [AppModelSelectionPayload](#appmodelselectionpayload) | | Yes |
|
|
| more_like_this | [AppFeaturePayload](#appfeaturepayload) | | No |
|
|
| opening_statement | string | | No |
|
|
| pre_prompt | string | | No |
|
|
| prompt_type | string, <br>**Available values:** "", "advanced", "simple" | | No |
|
|
| retriever_resource | [AppFeaturePayload](#appfeaturepayload) | | No |
|
|
| sensitive_word_avoidance | [AppModerationPayload](#appmoderationpayload) | | No |
|
|
| speech_to_text | [AppFeaturePayload](#appfeaturepayload) | | No |
|
|
| suggested_questions | [ string ] | | No |
|
|
| suggested_questions_after_answer | [AppSuggestedQuestionsPayload](#appsuggestedquestionspayload) | | No |
|
|
| text_to_speech | [AppTextToSpeechPayload](#apptexttospeechpayload) | | No |
|
|
| user_input_form | [ [AppUserInputFormPayload](#appuserinputformpayload) ] | | No |
|
|
|
|
#### AppModelConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_mode | [AppAgentModeResponse](#appagentmoderesponse) | | Yes |
|
|
| annotation_reply | [AppAnnotationReplyEnabledResponse](#appannotationreplyenabledresponse)<br>[AppAnnotationReplyDisabledResponse](#appannotationreplydisabledresponse) | | Yes |
|
|
| chat_prompt_config | [AppChatPromptConfigResponse](#appchatpromptconfigresponse) | | Yes |
|
|
| completion_prompt_config | [AppCompletionPromptConfigResponse](#appcompletionpromptconfigresponse) | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| dataset_configs | [AppDatasetConfigsResponse](#appdatasetconfigsresponse) | | Yes |
|
|
| dataset_query_variable | string | | Yes |
|
|
| external_data_tools | [ [AppEnabledExternalDataToolResponse](#appenabledexternaldatatoolresponse)<br>[AppDisabledExternalDataToolResponse](#appdisabledexternaldatatoolresponse) ] | | Yes |
|
|
| file_upload | [AppFileUploadResponse](#appfileuploadresponse) | | Yes |
|
|
| model | [AppModelSelectionResponse](#appmodelselectionresponse) | | Yes |
|
|
| more_like_this | [AppEnabledConfigResponse](#appenabledconfigresponse) | | Yes |
|
|
| opening_statement | string | | Yes |
|
|
| pre_prompt | string | | Yes |
|
|
| prompt_type | [PromptType](#prompttype) | | Yes |
|
|
| retriever_resource | [AppEnabledConfigResponse](#appenabledconfigresponse) | | Yes |
|
|
| sensitive_word_avoidance | [AppSensitiveWordAvoidanceResponse](#appsensitivewordavoidanceresponse) | | Yes |
|
|
| speech_to_text | [AppEnabledConfigResponse](#appenabledconfigresponse) | | Yes |
|
|
| suggested_questions | [ string ] | | Yes |
|
|
| suggested_questions_after_answer | [AppSuggestedQuestionsAfterAnswerResponse](#appsuggestedquestionsafteranswerresponse) | | Yes |
|
|
| text_to_speech | [AppTextToSpeechResponse](#apptexttospeechresponse) | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| user_input_form | [ [AppTextInputFormResponse](#apptextinputformresponse)<br>[AppSelectFormResponse](#appselectformresponse)<br>[AppParagraphFormResponse](#appparagraphformresponse)<br>[AppNumberFormResponse](#appnumberformresponse)<br>[AppCheckboxFormResponse](#appcheckboxformresponse)<br>[AppFileFormResponse](#appfileformresponse)<br>[AppFileListFormResponse](#appfilelistformresponse)<br>[AppExternalDataToolFormResponse](#appexternaldatatoolformresponse)<br>[AppJsonObjectFormResponse](#appjsonobjectformresponse) ] | | Yes |
|
|
|
|
#### AppModelSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | Yes |
|
|
| mode | string | | No |
|
|
| name | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### AppModelSelectionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | No |
|
|
| mode | [LLMMode](#llmmode)<br>string | | No |
|
|
| name | string | | No |
|
|
| provider | string | | No |
|
|
|
|
#### AppModerationConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_based_extension_id | string | | No |
|
|
| inputs_config | [AppModerationContentPayload](#appmoderationcontentpayload) | | No |
|
|
| keywords | string | | No |
|
|
| outputs_config | [AppModerationContentPayload](#appmoderationcontentpayload) | | No |
|
|
|
|
#### AppModerationContentPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| preset_response | string | | No |
|
|
|
|
#### AppModerationPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | [AppModerationConfigPayload](#appmoderationconfigpayload) | | No |
|
|
| enabled | boolean | | No |
|
|
| type | string | | No |
|
|
|
|
#### AppMoreLikeThisDisabledError
|
|
|
|
The 'More like this' feature is disabled. Please refresh your page.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppMoreLikeThisDisabledError | | The 'More like this' feature is disabled. Please refresh your page. | |
|
|
|
|
#### AppNamePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | Name to check | Yes |
|
|
|
|
#### AppNetworkAccessGroupBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_points | [ string, <br>**Available values:** "mcp", "service_api", "trigger", "webapp" ] | | Yes |
|
|
| app_id | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| group_id | string | | No |
|
|
| id | string | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| updated_by_account_id | string | | No |
|
|
| version | integer | | Yes |
|
|
|
|
#### AppNetworkAccessGroupMutationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available_access_points | [ string, <br>**Available values:** "mcp", "service_api", "trigger", "webapp" ] | | Yes |
|
|
| binding | [AppNetworkAccessGroupBindingResponse](#appnetworkaccessgroupbindingresponse) | | Yes |
|
|
| effective_enabled | boolean | | Yes |
|
|
|
|
#### AppNetworkAccessGroupResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| available_access_points | [ string, <br>**Available values:** "mcp", "service_api", "trigger", "webapp" ] | | Yes |
|
|
| binding | [AppNetworkAccessGroupBindingResponse](#appnetworkaccessgroupbindingresponse) | | Yes |
|
|
| effective_enabled | boolean | | Yes |
|
|
| entitled | boolean | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### AppNetworkAccessGroupStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available_count | integer | | Yes |
|
|
| configured | boolean | | Yes |
|
|
| covered_count | integer | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| entitled | boolean | | Yes |
|
|
|
|
#### AppNetworkAccessGroupUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_points | [ string, <br>**Available values:** "mcp", "service_api", "trigger", "webapp" ] | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| expected_version | integer | | Yes |
|
|
| group_id | string | | Yes |
|
|
|
|
#### AppNotFoundError
|
|
|
|
App not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppNotFoundError | | App not found. | |
|
|
|
|
#### AppNumberFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| number | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppNumberInputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| number | [AppInputFieldPayload](#appinputfieldpayload) | | Yes |
|
|
|
|
#### AppOwnerUnavailableError
|
|
|
|
The app preview owner is unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppOwnerUnavailableError | | The app preview owner is unavailable. | |
|
|
|
|
#### AppPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AppPartial](#apppartial) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### AppParagraphFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| paragraph | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppParagraphInputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| paragraph | [AppInputFieldPayload](#appinputfieldpayload) | | Yes |
|
|
|
|
#### AppPartial
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_mode | [WebAppAccessMode](#webappaccessmode) | | No |
|
|
| app_id | string | | No |
|
|
| author_name | string | | No |
|
|
| bound_agent_id | string | | No |
|
|
| create_user_name | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| description | string | | No |
|
|
| has_draft_trigger | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [IconType](#icontype) | | No |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| is_starred | boolean | | No |
|
|
| maintainer | string | | No |
|
|
| max_active_requests | integer | | No |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| model_config | [ModelConfigPartial](#modelconfigpartial) | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| tags | [ [Tag](#tag) ] | | No |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| use_icon_as_answer_icon | boolean | | No |
|
|
| workflow | [WorkflowPartial](#workflowpartial) | | No |
|
|
|
|
#### AppPromptMessagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| role | string | | Yes |
|
|
| text | string | | Yes |
|
|
|
|
#### AppProviderAgentToolPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
| enabled | boolean | | No |
|
|
| isDeleted | boolean | | No |
|
|
| notAuthor | boolean | | No |
|
|
| plugin_unique_identifier | string | | No |
|
|
| provider_id | string | | Yes |
|
|
| provider_name | string | | No |
|
|
| provider_type | [ToolProviderType](#toolprovidertype) | | Yes |
|
|
| tool_label | string | | No |
|
|
| tool_name | string | | Yes |
|
|
| tool_parameters | object | | Yes |
|
|
|
|
#### AppProviderAgentToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
| enabled | boolean | | No |
|
|
| isDeleted | boolean | | No |
|
|
| notAuthor | boolean | | No |
|
|
| plugin_unique_identifier | string | | No |
|
|
| provider_id | string | | Yes |
|
|
| provider_name | string | | No |
|
|
| provider_type | [ToolProviderType](#toolprovidertype) | | Yes |
|
|
| tool_label | string | | No |
|
|
| tool_name | string | | Yes |
|
|
| tool_parameters | object | | Yes |
|
|
|
|
#### AppRerankingModelPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reranking_model_name | string | | No |
|
|
| reranking_provider_name | string | | No |
|
|
|
|
#### AppRerankingModelResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reranking_model_name | string | | No |
|
|
| reranking_provider_name | string | | No |
|
|
|
|
#### AppRetrievalWeightsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_setting | [AppKeywordWeightPayload](#appkeywordweightpayload) | | Yes |
|
|
| vector_setting | [AppVectorWeightPayload](#appvectorweightpayload) | | Yes |
|
|
| weight_type | string, <br>**Available values:** "customized", "keyword_first", "semantic_first" | *Enum:* `"customized"`, `"keyword_first"`, `"semantic_first"` | No |
|
|
|
|
#### AppSelectFieldPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | No |
|
|
| default | [AppConfigJsonValue](#appconfigjsonvalue) | | No |
|
|
| description | string | | No |
|
|
| enabled | boolean | | No |
|
|
| hide | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| json_schema | string<br>object | | No |
|
|
| label | string | | Yes |
|
|
| max_length | integer | | No |
|
|
| options | [ string ] | | No |
|
|
| required | boolean | | No |
|
|
| type | string | | No |
|
|
| variable | string | | Yes |
|
|
|
|
#### AppSelectFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| select | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppSelectInputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| select | [AppSelectFieldPayload](#appselectfieldpayload) | | Yes |
|
|
|
|
#### AppSelectorScope
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppSelectorScope | string | | |
|
|
|
|
#### AppSensitiveWordAvoidanceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | No |
|
|
| configs | [ [JsonValue](#jsonvalue) ] | | No |
|
|
| enabled | boolean | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### AppSiteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| code | string | | No |
|
|
| copyright | string | | No |
|
|
| custom_disclaimer | string | | No |
|
|
| customize_domain | string | | No |
|
|
| customize_token_strategy | string | | Yes |
|
|
| default_language | string | | Yes |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| input_placeholder | string | | No |
|
|
| privacy_policy | string | | No |
|
|
| prompt_public | boolean | | Yes |
|
|
| show_workflow_steps | boolean | | Yes |
|
|
| title | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
|
|
#### AppSiteStatusPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enable_site | boolean | Enable or disable site | Yes |
|
|
|
|
#### AppSiteUnavailableError
|
|
|
|
The app preview site is unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppSiteUnavailableError | | The app preview site is unavailable. | |
|
|
|
|
#### AppSiteUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chat_color_theme | string | | No |
|
|
| chat_color_theme_inverted | boolean | | No |
|
|
| copyright | string | | No |
|
|
| custom_disclaimer | string | | No |
|
|
| customize_domain | string | | No |
|
|
| customize_token_strategy | string, <br>**Available values:** "allow", "must", "not_allow" | | No |
|
|
| default_language | string | | No |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| input_placeholder | string | | No |
|
|
| privacy_policy | string | | No |
|
|
| prompt_public | boolean | | No |
|
|
| show_workflow_steps | boolean | | No |
|
|
| title | string | | No |
|
|
| use_icon_as_answer_icon | boolean | | No |
|
|
|
|
#### AppSuggestedQuestionsAfterAnswerDisabledError
|
|
|
|
Function Suggested questions after answer disabled.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppSuggestedQuestionsAfterAnswerDisabledError | | Function Suggested questions after answer disabled. | |
|
|
|
|
#### AppSuggestedQuestionsAfterAnswerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| model | [AppModelSelectionResponse](#appmodelselectionresponse) | | No |
|
|
| prompt | string | | No |
|
|
|
|
#### AppSuggestedQuestionsModelPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | No |
|
|
| mode | [LLMMode](#llmmode)<br>string | | No |
|
|
| name | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### AppSuggestedQuestionsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| model | [AppSuggestedQuestionsModelPayload](#appsuggestedquestionsmodelpayload) | | No |
|
|
| prompt | string | | No |
|
|
|
|
#### AppTextInputFormResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text-input | [AppUserInputFormConfigResponse](#appuserinputformconfigresponse) | | Yes |
|
|
|
|
#### AppTextInputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text-input | [AppInputFieldPayload](#appinputfieldpayload) | | Yes |
|
|
|
|
#### AppTextToSpeechPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| autoPlay | string, <br>**Available values:** "disabled", "enabled" | *Enum:* `"disabled"`, `"enabled"` | No |
|
|
| enabled | boolean | | No |
|
|
| language | string | | No |
|
|
| voice | string | | No |
|
|
|
|
#### AppTextToSpeechResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| autoPlay | string, <br>**Available values:** "disabled", "enabled" | *Enum:* `"disabled"`, `"enabled"` | No |
|
|
| enabled | boolean | | Yes |
|
|
| language | string | | No |
|
|
| voice | string | | No |
|
|
|
|
#### AppTracePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| capture_agent | boolean, <br>**Default:** true | Capture Agent internals when deployment support is enabled | No |
|
|
| capture_content | boolean | Include prompt, output and tool content in new traces | No |
|
|
| enabled | boolean | Enable or disable tracing | Yes |
|
|
| tracing_provider | string | Tracing provider | No |
|
|
|
|
#### AppTraceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| capture_agent | boolean, <br>**Default:** true | | No |
|
|
| capture_content | boolean | | No |
|
|
| enabled | boolean | | No |
|
|
| tracing_provider | string | | No |
|
|
|
|
#### AppTriggerNotFoundError
|
|
|
|
Trigger not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppTriggerNotFoundError | | Trigger not found. | |
|
|
|
|
#### AppUnavailableError
|
|
|
|
App unavailable, please check your app configurations.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppUnavailableError | | App unavailable, please check your app configurations. | |
|
|
|
|
#### AppUserInputFormConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | No |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
| config | object | | No |
|
|
| default | [JsonValue](#jsonvalue) | | No |
|
|
| description | string | | No |
|
|
| enabled | boolean | | No |
|
|
| hide | boolean | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| json_schema | string<br>object | | No |
|
|
| label | string | | Yes |
|
|
| max_length | integer | | No |
|
|
| options | [ string ] | | No |
|
|
| required | boolean | | No |
|
|
| type | string | | No |
|
|
| variable | string | | Yes |
|
|
|
|
#### AppUserInputFormPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AppUserInputFormPayload | [AppTextInputPayload](#apptextinputpayload)<br>[AppSelectInputPayload](#appselectinputpayload)<br>[AppParagraphInputPayload](#appparagraphinputpayload)<br>[AppNumberInputPayload](#appnumberinputpayload)<br>[AppCheckboxInputPayload](#appcheckboxinputpayload)<br>[AppExternalDataInputPayload](#appexternaldatainputpayload) | | |
|
|
|
|
#### AppVariableConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | | | No |
|
|
| name | string | | Yes |
|
|
| required | boolean | | No |
|
|
| type | string | | Yes |
|
|
|
|
#### AppVectorSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | | Yes |
|
|
| embedding_provider_name | string | | Yes |
|
|
| vector_weight | number | | Yes |
|
|
|
|
#### AppVectorWeightPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | | Yes |
|
|
| embedding_provider_name | string | | Yes |
|
|
| vector_weight | number | | Yes |
|
|
|
|
#### AppWeightsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_setting | [AppKeywordSettingResponse](#appkeywordsettingresponse) | | Yes |
|
|
| vector_setting | [AppVectorSettingResponse](#appvectorsettingresponse) | | Yes |
|
|
| weight_type | string, <br>**Available values:** "customized", "keyword_first", "semantic_first" | *Enum:* `"customized"`, `"keyword_first"`, `"semantic_first"` | No |
|
|
|
|
#### ArchivedDocumentImmutableError
|
|
|
|
The archived document is not editable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ArchivedDocumentImmutableError | | The archived document is not editable. | |
|
|
|
|
#### AudioBinaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AudioBinaryResponse | string | | |
|
|
|
|
#### AudioTooLargeError
|
|
|
|
Audio size exceeded. {message}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AudioTooLargeError | | Audio size exceeded. {message} | |
|
|
|
|
#### AudioTranscriptResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text | string | Transcribed text from audio | Yes |
|
|
|
|
#### AuthenticationFailedError
|
|
|
|
Invalid email or password.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AuthenticationFailedError | | Invalid email or password. | |
|
|
|
|
#### AuthorizedCategory
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| AuthorizedCategory | string | | |
|
|
|
|
#### AutoDisableLogsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer | | Yes |
|
|
| document_ids | [ string ] | | Yes |
|
|
|
|
#### AvailableModelListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ProviderWithModelsResponse](#providerwithmodelsresponse) ] | | Yes |
|
|
|
|
#### AvatarUrlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | | Yes |
|
|
|
|
#### AverageResponseTimeStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| latency | number | | Yes |
|
|
|
|
#### AverageResponseTimeStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AverageResponseTimeStatisticItem](#averageresponsetimestatisticitem) ] | | Yes |
|
|
|
|
#### AverageSessionInteractionStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| interactions | number | | Yes |
|
|
|
|
#### AverageSessionInteractionStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AverageSessionInteractionStatisticItem](#averagesessioninteractionstatisticitem) ] | | Yes |
|
|
|
|
#### BadRequestError
|
|
|
|
annotation_ids are required if the parameter is provided.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BadRequestError | | annotation_ids are required if the parameter is provided. | |
|
|
|
|
#### BannerContentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | string | | Yes |
|
|
| description | string | | Yes |
|
|
| img-src | string | | Yes |
|
|
| title | string | | Yes |
|
|
|
|
#### BannerListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BannerListResponse | array | | |
|
|
|
|
#### BannerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | [BannerContentResponse](#bannercontentresponse) | | Yes |
|
|
| created_at | string | | Yes |
|
|
| id | string | | Yes |
|
|
| link | string | | Yes |
|
|
| sort | integer | | Yes |
|
|
| status | [BannerStatus](#bannerstatus) | | Yes |
|
|
|
|
#### BannerStatus
|
|
|
|
ExporleBanner status
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BannerStatus | string | ExporleBanner status | |
|
|
|
|
#### BatchGetContactOptionsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact_ids | [ string ] | Contact IDs persisted in workflow recipient configuration. | Yes |
|
|
|
|
#### BatchGetContactOptionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ContactOption](#contactoption) ] | Selectable contacts resolved in request order. | Yes |
|
|
|
|
#### BatchGetContactsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [HumanInputContactSummary](#humaninputcontactsummary) ] | List of retrieved human input contacts. | Yes |
|
|
|
|
#### BatchImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| upload_file_id | string | | Yes |
|
|
|
|
#### BillingInvoiceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string | | Yes |
|
|
|
|
#### BillingModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| subscription | [SubscriptionModel](#subscriptionmodel) | | Yes |
|
|
|
|
#### BillingOperationFailedError
|
|
|
|
We couldn't complete this request. Please try again. If the problem persists, contact support.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BillingOperationFailedError | | We couldn't complete this request. Please try again. If the problem persists, contact support. | |
|
|
|
|
#### BillingOperationFailedErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| message | string | | Yes |
|
|
| status | integer | | Yes |
|
|
|
|
#### BillingRequestInProgressError
|
|
|
|
A previous request is still being processed. Please try again shortly.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BillingRequestInProgressError | | A previous request is still being processed. Please try again shortly. | |
|
|
|
|
#### BillingSubscriptionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string | | Yes |
|
|
|
|
#### BillingUnavailableError
|
|
|
|
This operation is temporarily unavailable. Please try again later.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BillingUnavailableError | | This operation is temporarily unavailable. Please try again later. | |
|
|
|
|
#### BillingUnavailableErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| message | string | | Yes |
|
|
| status | integer | | Yes |
|
|
|
|
#### BillingUnprocessableEntityErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| message | string | | Yes |
|
|
| status | integer | | Yes |
|
|
|
|
#### BinaryFileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BinaryFileResponse | string | | |
|
|
|
|
#### BindingFileDownloadUnavailableError
|
|
|
|
Sandbox file download is unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| BindingFileDownloadUnavailableError | | Sandbox file download is unavailable. | |
|
|
|
|
#### BoundRecipient
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reference_id | string | | Yes |
|
|
| type | string, <br>**Default:** member | | No |
|
|
|
|
#### BrandingModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| application_title | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| favicon | string | | Yes |
|
|
| login_page_logo | string | | Yes |
|
|
| workspace_logo | string | | Yes |
|
|
|
|
#### BuiltinCredentialListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| include_credential_ids | [ string ] | Credential IDs to include even if visibility would hide them | No |
|
|
|
|
#### BuiltinProviderDefaultCredentialPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
|
|
#### BuiltinProviderOAuthClientSchemaResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_params | object | | No |
|
|
| is_oauth_custom_client_enabled | boolean | | Yes |
|
|
| is_system_oauth_params_exists | boolean | | Yes |
|
|
| redirect_uri | string | | Yes |
|
|
| schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
|
|
|
|
#### BuiltinToolAddPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| name | string | | No |
|
|
| type | [CredentialType](#credentialtype) | | Yes |
|
|
| visibility | string | | No |
|
|
|
|
#### BuiltinToolCredentialDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
|
|
#### BuiltinToolUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| credentials | object | | No |
|
|
| name | string | | No |
|
|
|
|
#### ButtonStyle
|
|
|
|
Button styles for user actions.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ButtonStyle | string | Button styles for user actions. | |
|
|
|
|
#### CannotOperateSelfError
|
|
|
|
Cannot operate on yourself.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CannotOperateSelfError | | Cannot operate on yourself. | |
|
|
|
|
#### CannotTransferOwnerToSelfError
|
|
|
|
You cannot transfer ownership to yourself.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CannotTransferOwnerToSelfError | | You cannot transfer ownership to yourself. | |
|
|
|
|
#### ChangeEmailResetPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_email | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### ChangeEmailSendPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| language | string | | No |
|
|
| phase | string | | No |
|
|
| token | string | | No |
|
|
|
|
#### ChangeEmailValidityPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| email | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### ChannelConflictResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string, <br>**Available values:** "provider_configuration_updated", "replacement_required" | *Enum:* `"provider_configuration_updated"`, `"replacement_required"` | Yes |
|
|
| message | string | | Yes |
|
|
| status | integer, <br>**Default:** 409 | | No |
|
|
|
|
#### ChannelDeleteQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expected_config_version | [ConfigVersion](#configversion) | | Yes |
|
|
|
|
#### ChannelDeleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channel_id | [ChannelId](#channelid) | | Yes |
|
|
|
|
#### ChannelId
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ChannelId | string | | |
|
|
|
|
#### ChannelProvider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| connection_mode | string, <br>**Default:** custom_app | | No |
|
|
| provider | [EmailProviderType](#emailprovidertype)<br>[IMProvider](#improvider) | | Yes |
|
|
|
|
#### ChannelStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ChannelStatus | string | | |
|
|
|
|
#### ChannelSummary
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config_version | [ConfigVersion](#configversion) | The current opaque configuration version used for optimistic concurrency control. | Yes |
|
|
| created_at | integer | Unix timestamp in seconds | Yes |
|
|
| display_identifier | string | The display identifier of the Channel. | Yes |
|
|
| id | [ChannelId](#channelid) | | Yes |
|
|
| kind | string, <br>**Available values:** "email", "im" | *Enum:* `"email"`, `"im"` | Yes |
|
|
| provider | [EmailProviderType](#emailprovidertype)<br>[IMProvider](#improvider) | The provider of the Channel. The concrete provider type depends on the `kind` field. | Yes |
|
|
| status | [ChannelStatus](#channelstatus) | | Yes |
|
|
| status_description | string | Human-readable status description. Empty when the status is `configured` or `connected`. | Yes |
|
|
| updated_at | integer | Unix timestamp in seconds | Yes |
|
|
| webhook_url | string | Webhook URL to configure on the provider side. None when webhook configuration is not required or the provider does not support webhooks. | Yes |
|
|
|
|
#### ChannelTestResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| status | [ChannelStatus](#channelstatus) | | Yes |
|
|
| status_description | string | | Yes |
|
|
|
|
#### ChatConversationQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_status | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all | Annotation status filter<br>*Enum:* `"all"`, `"annotated"`, `"not_annotated"` | No |
|
|
| end | string | End date (YYYY-MM-DD HH:MM) | No |
|
|
| keyword | string | Search keyword | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| sort_by | string, <br>**Available values:** "-created_at", "-updated_at", "created_at", "updated_at", <br>**Default:** -updated_at | Sort field and direction<br>*Enum:* `"-created_at"`, `"-updated_at"`, `"created_at"`, `"updated_at"` | No |
|
|
| start | string | Start date (YYYY-MM-DD HH:MM) | No |
|
|
|
|
#### ChatMessageExplorePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | | No |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
| parent_message_id | string | | No |
|
|
| query | string | | Yes |
|
|
| retriever_from | string, <br>**Default:** explore_app | | No |
|
|
|
|
#### ChatMessagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | Conversation ID | No |
|
|
| draft_type | string, <br>**Available values:** "debug_build", "draft", <br>**Default:** draft | Agent App debug config source. Use debug_build while the Agent is in build mode.<br>*Enum:* `"debug_build"`, `"draft"` | No |
|
|
| files | [ object ] | Uploaded files | No |
|
|
| inputs | object | | Yes |
|
|
| model_config | object | | No |
|
|
| parent_message_id | string | Parent message ID | No |
|
|
| query | string | User query | Yes |
|
|
| response_mode | string, <br>**Available values:** "blocking", "streaming", <br>**Default:** blocking | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | No |
|
|
| retriever_from | string, <br>**Default:** dev | Retriever source | No |
|
|
|
|
#### ChatMessagesQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | Conversation ID | Yes |
|
|
| first_id | string | First message ID for pagination | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of messages to return (1-100) | No |
|
|
|
|
#### ChatPromptTemplateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| prompt | [ [PromptTemplateMessageResponse](#prompttemplatemessageresponse) ] | | Yes |
|
|
|
|
#### ChatRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | | No |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
| parent_message_id | string | | No |
|
|
| query | string | | Yes |
|
|
| retriever_from | string, <br>**Default:** explore_app | | No |
|
|
|
|
#### CheckDependenciesResult
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] | | No |
|
|
|
|
#### CheckEmailUniquePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
|
|
#### CheckResultView
|
|
|
|
``type_check`` / ``output_check`` per-output summary block.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| passed | boolean | | Yes |
|
|
| reason | string | | No |
|
|
|
|
#### ChildChunkBatchUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chunks | [ [ChildChunkUpdateArgs](#childchunkupdateargs) ] | | Yes |
|
|
|
|
#### ChildChunkBatchUpdateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ChildChunkResponse](#childchunkresponse) ] | | Yes |
|
|
|
|
#### ChildChunkCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Child chunk text content. | Yes |
|
|
|
|
#### ChildChunkDeleteIndexError
|
|
|
|
Delete child chunk index failed: {message}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ChildChunkDeleteIndexError | | Delete child chunk index failed: {message} | |
|
|
|
|
#### ChildChunkDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ChildChunkResponse](#childchunkresponse) | | Yes |
|
|
|
|
#### ChildChunkIndexingError
|
|
|
|
Create child chunk index failed: {message}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ChildChunkIndexingError | | Create child chunk index failed: {message} | |
|
|
|
|
#### ChildChunkListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### ChildChunkListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ChildChunkResponse](#childchunkresponse) ] | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
| total_pages | integer | | Yes |
|
|
|
|
#### ChildChunkResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| position | integer | | Yes |
|
|
| segment_id | string | | Yes |
|
|
| type | string, <br>**Available values:** "automatic", "customized" | *Enum:* `"automatic"`, `"customized"` | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| word_count | integer | | Yes |
|
|
|
|
#### ChildChunkUpdateArgs
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Child chunk text content. | Yes |
|
|
| id | string | Existing child chunk ID. Omit to create a new child chunk. | No |
|
|
|
|
#### ChildChunkUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Child chunk text content. | Yes |
|
|
|
|
#### CloudPlan
|
|
|
|
Enum representing user plan types in the cloud platform.
|
|
|
|
SANDBOX: Free/default plan with limited features
|
|
PROFESSIONAL: Professional paid plan
|
|
TEAM: Team collaboration paid plan
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CloudPlan | string | Enum representing user plan types in the cloud platform. SANDBOX: Free/default plan with limited features PROFESSIONAL: Professional paid plan TEAM: Team collaboration paid plan | |
|
|
|
|
#### CodeBasedExtensionItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| form_schema | [ object ] | | No |
|
|
| label | object | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### CodeBasedExtensionQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| module | string | | Yes |
|
|
|
|
#### CodeBasedExtensionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [CodeBasedExtensionItemResponse](#codebasedextensionitemresponse) ] | Non-builtin extensions of the module | Yes |
|
|
| module | string | Module name | Yes |
|
|
|
|
#### CompletionConversationQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_status | string, <br>**Available values:** "all", "annotated", "not_annotated", <br>**Default:** all | Annotation status filter<br>*Enum:* `"all"`, `"annotated"`, `"not_annotated"` | No |
|
|
| end | string | End date (YYYY-MM-DD HH:MM) | No |
|
|
| keyword | string | Search keyword | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| start | string | Start date (YYYY-MM-DD HH:MM) | No |
|
|
|
|
#### CompletionMessageExplorePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
| query | string | | No |
|
|
| response_mode | string, <br>**Available values:** "blocking", "streaming" | | No |
|
|
| retriever_from | string, <br>**Default:** explore_app | | No |
|
|
|
|
#### CompletionMessagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | Uploaded files | No |
|
|
| inputs | object | | Yes |
|
|
| model_config | object | | No |
|
|
| query | string | Query text | No |
|
|
| response_mode | string, <br>**Available values:** "blocking", "streaming", <br>**Default:** blocking | Response mode<br>*Enum:* `"blocking"`, `"streaming"` | No |
|
|
| retriever_from | string, <br>**Default:** dev | Retriever source | No |
|
|
|
|
#### CompletionPromptTemplateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_histories_role | [ConversationHistoriesRoleResponse](#conversationhistoriesroleresponse) | | No |
|
|
| prompt | [CompletionPromptTemplateTextResponse](#completionprompttemplatetextresponse) | | Yes |
|
|
|
|
#### CompletionPromptTemplateTextResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text | string | | Yes |
|
|
|
|
#### CompletionRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
| query | string | | No |
|
|
| response_mode | string, <br>**Available values:** "blocking", "streaming" | | No |
|
|
| retriever_from | string, <br>**Default:** explore_app | | No |
|
|
|
|
#### CompletionRequestError
|
|
|
|
Completion request failed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CompletionRequestError | | Completion request failed. | |
|
|
|
|
#### ComplianceDocumentNotFoundError
|
|
|
|
The compliance document was not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ComplianceDocumentNotFoundError | | The compliance document was not found. | |
|
|
|
|
#### ComplianceDownloadForbiddenError
|
|
|
|
Your current plan does not allow downloading this compliance document.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ComplianceDownloadForbiddenError | | Your current plan does not allow downloading this compliance document. | |
|
|
|
|
#### ComplianceDownloadQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| doc_name | string | Compliance document name | Yes |
|
|
|
|
#### ComplianceDownloadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string | | Yes |
|
|
|
|
#### ComplianceRateLimitError
|
|
|
|
Rate limit exceeded for downloading compliance report.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ComplianceRateLimitError | | Rate limit exceeded for downloading compliance report. | |
|
|
|
|
#### ComplianceRateLimitErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| message | string | | Yes |
|
|
| status | integer | | Yes |
|
|
|
|
#### ComposerBindingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | No |
|
|
| binding_type | string, <br>**Available values:** "inline_agent", "roster_agent" | *Enum:* `"inline_agent"`, `"roster_agent"` | Yes |
|
|
| current_snapshot_id | string | | No |
|
|
|
|
#### ComposerCandidateCapabilities
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| human_roster_available | boolean | | No |
|
|
|
|
#### ComposerKnowledgePlaceholderResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| placeholder_name | string | | Yes |
|
|
|
|
#### ComposerSavePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_soul | [AgentSoulConfig](#agentsoulconfig) | For Agent draft saves and workflow node_job_only updates, omit config_files to preserve the latest server-managed files. An explicit list replaces the files, including an empty list to clear them. | No |
|
|
| binding | [ComposerBindingPayload](#composerbindingpayload) | | No |
|
|
| client_revision_id | string | | No |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [AgentIconType](#agenticontype) | | No |
|
|
| idempotency_key | string | | No |
|
|
| new_agent_name | string | | No |
|
|
| node_job | [WorkflowNodeJobConfig](#workflownodejobconfig) | | No |
|
|
| role | string | | No |
|
|
| save_strategy | [ComposerSaveStrategy](#composersavestrategy) | | Yes |
|
|
| soul_lock | [ComposerSoulLockPayload](#composersoullockpayload) | | No |
|
|
| variant | [ComposerVariant](#composervariant) | | Yes |
|
|
| version_note | string | | No |
|
|
|
|
#### ComposerSaveStrategy
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ComposerSaveStrategy | string | | |
|
|
|
|
#### ComposerSoulLockPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| locked | boolean, <br>**Default:** true | | No |
|
|
| unlocked_from_version_id | string | | No |
|
|
|
|
#### ComposerValidationFindingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| knowledge_retrieval_placeholder | [ [ComposerKnowledgePlaceholderResponse](#composerknowledgeplaceholderresponse) ] | | No |
|
|
| warnings | [ [ComposerValidationWarningResponse](#composervalidationwarningresponse) ] | | No |
|
|
|
|
#### ComposerValidationWarningResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| id | string | | No |
|
|
| kind | string | | No |
|
|
| message | string | | No |
|
|
| surface | string | | No |
|
|
|
|
#### ComposerVariant
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ComposerVariant | string | | |
|
|
|
|
#### Condition
|
|
|
|
Condition detail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| comparison_operator | string, <br>**Available values:** "<", "=", ">", "after", "before", "contains", "empty", "end with", "in", "is", "is not", "not contains", "not empty", "not in", "start with", "≠", "≤", "≥" | Comparison to apply. String operators (`contains`, `not contains`, `start with`, `end with`, `is`, `is not`, `empty`, `not empty`, `in`, `not in`) act on string or array metadata; numeric operators (`=`, `≠`, `>`, `<`, `≥`, `≤`) act on numeric metadata; time operators (`before`, `after`) act on time metadata.<br>*Enum:* `"<"`, `"="`, `">"`, `"after"`, `"before"`, `"contains"`, `"empty"`, `"end with"`, `"in"`, `"is"`, `"is not"`, `"not contains"`, `"not empty"`, `"not in"`, `"start with"`, `"≠"`, `"≤"`, `"≥"` | Yes |
|
|
| name | string | Metadata field name to compare against. | Yes |
|
|
| value | string<br>[ string ]<br>number | Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omit or use `null` for `empty` and `not empty`. | No |
|
|
|
|
#### ConfigVersion
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConfigVersion | string | | |
|
|
|
|
#### ConfigurateMethod
|
|
|
|
Enum class for configurate method of provider model.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConfigurateMethod | string | Enum class for configurate method of provider model. | |
|
|
|
|
#### ConsoleDatasetListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| creator_ids | [ string ] | Filter by creator account IDs | No |
|
|
| ids | [ string ] | Filter by dataset IDs | No |
|
|
| include_all | boolean | Include all datasets | No |
|
|
| keyword | string | Search keyword | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of items per page | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| tag_ids | [ string ] | Filter by tag IDs | No |
|
|
|
|
#### ConsoleHumanInputFormDefinitionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConsoleHumanInputFormDefinitionResponse | object | | |
|
|
|
|
#### ConsoleHumanInputFormSubmitResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConsoleHumanInputFormSubmitResponse | object | | |
|
|
|
|
#### ConsoleHumanInputV2FormDefinitionResponse
|
|
|
|
Frozen form definition and effective expiration in UTC epoch seconds.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expiration_time | integer | | Yes |
|
|
| resolved_form | [ResolvedForm](#resolvedform) | | Yes |
|
|
|
|
#### ConsoleHumanInputV2SubmitPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
|
|
#### ConsoleHumanInputV2SubmitResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
|
|
#### ConsoleSegmentListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SegmentResponse](#segmentresponse) ] | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
| total_pages | integer | | Yes |
|
|
|
|
#### Contact
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact_id | string | | Yes |
|
|
| type | string, <br>**Default:** contact | | No |
|
|
|
|
#### ContactIMBindingDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| identity | [ContactIMIdentityDetail](#contactimidentitydetail) | | Yes |
|
|
| provider | [IMProvider](#improvider) | | Yes |
|
|
| scope | [IMBindingScope](#imbindingscope) | | Yes |
|
|
|
|
#### ContactIMIdentityDetail
|
|
|
|
Display fields for the identity selected by an effective contact binding.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| display_name | string | | Yes |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| provider_user_id | string | | Yes |
|
|
|
|
#### ContactListQuery
|
|
|
|
Query params for listing contacts in the workspace directory.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| group | [HumanInputContactType](#humaninputcontacttype) | Optional contact type filter. None means all contacts. | No |
|
|
| keyword | string | Free-text search against contact name or email. | No |
|
|
| limit | integer, <br>**Default:** 20 | Maximum number of records returned per page. | No |
|
|
| page | integer, <br>**Default:** 1 | 1-based page number. | No |
|
|
|
|
#### ContactOption
|
|
|
|
Least-privilege contact projection returned to workflow editors.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | Signed avatar URL if one is available. | No |
|
|
| email | string | Current deliverable Email, when available. | No |
|
|
| id | string | Unique contact identifier persisted in workflow recipient configuration. | Yes |
|
|
| im_providers | [ [IMProvider](#improvider) ] | Distinct providers of effective IM bindings in the current workspace; not a delivery health check. | Yes |
|
|
| name | string | Display name shown in the contact picker. | Yes |
|
|
| type | [HumanInputContactType](#humaninputcontacttype) | Resolved contact type in the current workspace scope. | Yes |
|
|
|
|
#### ContactOptionsQuery
|
|
|
|
Query params for selecting contacts in workflow editors.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Free-text search against selectable contact names. | No |
|
|
| limit | integer, <br>**Default:** 20 | Maximum number of records returned per page. | No |
|
|
| page | integer, <br>**Default:** 1 | 1-based page number. | No |
|
|
|
|
#### Conversation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| admin_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
|
|
| annotation | [ConversationAnnotation](#conversationannotation) | | No |
|
|
| created_at | integer | | No |
|
|
| from_account_id | string | | No |
|
|
| from_account_name | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_end_user_session_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| id | string | | Yes |
|
|
| message | [SimpleMessageDetail](#simplemessagedetail) | | No |
|
|
| model_config | [SimpleModelConfig](#simplemodelconfig) | | No |
|
|
| read_at | integer | | No |
|
|
| status | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| user_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
|
|
|
|
#### ConversationAnnotation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account | [SimpleAccount](#simpleaccount) | | No |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| question | string | | No |
|
|
|
|
#### ConversationAnnotationHitHistory
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_create_account | [SimpleAccount](#simpleaccount) | | No |
|
|
| annotation_id | string | | Yes |
|
|
| created_at | integer | | No |
|
|
|
|
#### ConversationCursorNotFoundError
|
|
|
|
The conversation cursor is not in the current list. Refresh the list and try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConversationCursorNotFoundError | | The conversation cursor is not in the current list. Refresh the list and try again. | |
|
|
|
|
#### ConversationDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| admin_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
|
|
| annotated | boolean | | Yes |
|
|
| created_at | integer | | No |
|
|
| from_account_id | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| id | string | | Yes |
|
|
| introduction | string | | No |
|
|
| message_count | integer | | Yes |
|
|
| model_config | [ConversationModelConfig](#conversationmodelconfig) | | No |
|
|
| status | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| user_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
|
|
|
|
#### ConversationFirstMessageNotFoundError
|
|
|
|
The conversation has no message from which to generate a name.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConversationFirstMessageNotFoundError | | The conversation has no message from which to generate a name. | |
|
|
|
|
#### ConversationHistoriesRoleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| assistant_prefix | string | | Yes |
|
|
| user_prefix | string | | Yes |
|
|
|
|
#### ConversationInfiniteScrollPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SimpleConversation](#simpleconversation) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
|
|
#### ConversationListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_id | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| pinned | boolean | | No |
|
|
|
|
#### ConversationMessageDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| from_account_id | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| id | string | | Yes |
|
|
| message | [MessageDetail](#messagedetail) | | No |
|
|
| model_config | [ConversationModelConfig](#conversationmodelconfig) | | No |
|
|
| status | string | | Yes |
|
|
|
|
#### ConversationModelConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_mode | [AnyJSONValue](#anyjsonvalue) | | No |
|
|
| model | [AnyJSONValue](#anyjsonvalue) | | No |
|
|
| opening_statement | string | | No |
|
|
| pre_prompt | string | | No |
|
|
| suggested_questions | [AnyJSONValue](#anyjsonvalue) | | No |
|
|
| user_input_form | [AnyJSONValue](#anyjsonvalue) | | No |
|
|
|
|
#### ConversationNameRequiredError
|
|
|
|
A name is required when automatic naming is disabled.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConversationNameRequiredError | | A name is required when automatic naming is disabled. | |
|
|
|
|
#### ConversationNotFoundError
|
|
|
|
The conversation was not found for this user and app.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ConversationNotFoundError | | The conversation was not found for this user and app. | |
|
|
|
|
#### ConversationPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [Conversation](#conversation) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### ConversationRenamePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_generate | boolean | Automatically generate the conversation name. When `true`, the `name` field is ignored. | No |
|
|
| name | string | Conversation name. Required when `auto_generate` is `false`. | No |
|
|
|
|
#### ConversationVariableItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| id | string | | No |
|
|
| name | string | | No |
|
|
| value | | | No |
|
|
| value_type | string | | No |
|
|
|
|
#### ConversationVariableResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| value | string | | No |
|
|
| value_type | string | | Yes |
|
|
|
|
#### ConversationVariableUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_variables | [ [ConversationVariableItemPayload](#conversationvariableitempayload) ] | Conversation variables for the draft workflow | Yes |
|
|
|
|
#### ConversationVariablesQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | Conversation ID to filter variables | Yes |
|
|
|
|
#### ConversationWithSummary
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| admin_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
|
|
| annotated | boolean | | Yes |
|
|
| created_at | integer | | No |
|
|
| from_account_id | string | | No |
|
|
| from_account_name | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_end_user_session_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| id | string | | Yes |
|
|
| message_count | integer | | Yes |
|
|
| model_config | [SimpleModelConfig](#simplemodelconfig) | | No |
|
|
| name | string | | Yes |
|
|
| read_at | integer | | No |
|
|
| status | string | | Yes |
|
|
| status_count | [StatusCount](#statuscount) | | No |
|
|
| summary | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| user_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
|
|
|
|
#### ConversationWithSummaryPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ConversationWithSummary](#conversationwithsummary) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### ConvertToWorkflowPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| name | string | | No |
|
|
|
|
#### CopyAppPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | Description for the copied app | No |
|
|
| icon | string | Icon | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
| name | string | Name for the copied app | No |
|
|
|
|
#### CopyRoleParam
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| copy_member | boolean, <br>**Default:** true | | No |
|
|
|
|
#### CrawlFailedError
|
|
|
|
{message}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CrawlFailedError | | {message} | |
|
|
|
|
#### CreateAnnotationPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_reply | object | Annotation reply data | No |
|
|
| answer | string | Answer text | No |
|
|
| content | string | Content text | No |
|
|
| message_id | string | Message ID | No |
|
|
| question | string | Question text | No |
|
|
|
|
#### CreateAppPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | App description (max 400 chars) | No |
|
|
| icon | string | Icon | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "agent-chat", "chat", "completion", "workflow" | App mode<br>*Enum:* `"advanced-chat"`, `"agent-chat"`, `"chat"`, `"completion"`, `"workflow"` | Yes |
|
|
| name | string | App name | Yes |
|
|
|
|
#### CreateIMBindingRequest
|
|
|
|
Request body for setting one workspace-scoped IM override.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| identity_id | string | Synced IM identity identifier selected as the workspace override. | Yes |
|
|
|
|
#### CreateIMBindingResponse
|
|
|
|
Response body returned after binding one IM identity to the workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContact](#humaninputcontact) | Contact snapshot after the IM identity is bound. | Yes |
|
|
|
|
#### CreateIMSyncRunResponse
|
|
|
|
Response body returned after creating one sync run.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| run | [IMSyncRun](#imsyncrun) | Newly created sync run snapshot. | Yes |
|
|
|
|
#### CreateSnippetPayload
|
|
|
|
Payload for creating a new snippet.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| graph | object | | No |
|
|
| icon_info | [IconInfo](#iconinfo) | | No |
|
|
| input_fields | [ [InputFieldDefinition](#inputfielddefinition) ] | | No |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "group", "node", <br>**Default:** node | *Enum:* `"group"`, `"node"` | No |
|
|
|
|
#### CreatorUserRole
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CreatorUserRole | string | | |
|
|
|
|
#### CredentialConfiguration
|
|
|
|
Model class for credential configuration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| credential_name | string | | Yes |
|
|
|
|
#### CredentialFormSchema
|
|
|
|
Model class for credential form schema.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | string | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| max_length | integer | | No |
|
|
| options | [ [FormOption](#formoption) ] | | No |
|
|
| placeholder | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| required | boolean, <br>**Default:** true | | No |
|
|
| show_on | [ [FormShowOnObject](#formshowonobject) ], <br>**Default:** | | No |
|
|
| type | [FormType](#formtype) | | Yes |
|
|
| variable | string | | Yes |
|
|
|
|
#### CredentialType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CredentialType | string | | |
|
|
|
|
#### CurrentPasswordIncorrectError
|
|
|
|
Current password is incorrect.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CurrentPasswordIncorrectError | | Current password is incorrect. | |
|
|
|
|
#### CurrentWorkspaceArchivedError
|
|
|
|
The current workspace has been archived.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CurrentWorkspaceArchivedError | | The current workspace has been archived. | |
|
|
|
|
#### CurrentWorkspaceSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credits | integer | Remaining credits in the effective pool; -1 means unlimited. | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| plan | [CloudPlan](#cloudplan) | | Yes |
|
|
| role | [TenantAccountRole](#tenantaccountrole) | | Yes |
|
|
|
|
#### CustomConfigurationResponse
|
|
|
|
Model class for provider custom configuration response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available_credentials | [ [CredentialConfiguration](#credentialconfiguration) ] | | No |
|
|
| can_added_models | [ [UnaddedModelConfiguration](#unaddedmodelconfiguration) ] | | No |
|
|
| current_credential_id | string | | No |
|
|
| current_credential_name | string | | No |
|
|
| custom_models | [ [CustomModelConfiguration](#custommodelconfiguration) ] | | No |
|
|
| status | [CustomConfigurationStatus](#customconfigurationstatus) | | Yes |
|
|
|
|
#### CustomConfigurationStatus
|
|
|
|
Enum class for custom configuration status.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CustomConfigurationStatus | string | Enum class for custom configuration status. | |
|
|
|
|
#### CustomModelConfiguration
|
|
|
|
Model class for provider custom model configuration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available_model_credentials | [ [CredentialConfiguration](#credentialconfiguration) ], <br>**Default:** | | No |
|
|
| credentials | object | | Yes |
|
|
| current_credential_id | string | | No |
|
|
| current_credential_name | string | | No |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| unadded_to_model_list | boolean | | No |
|
|
|
|
#### CustomizeTokenStrategy
|
|
|
|
Site token customization strategy
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| CustomizeTokenStrategy | string | Site token customization strategy | |
|
|
|
|
#### CustomizedPipelineTemplatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| icon_info | object | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### DailyConversationStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_count | integer | | Yes |
|
|
| date | string | | Yes |
|
|
|
|
#### DailyConversationStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DailyConversationStatisticItem](#dailyconversationstatisticitem) ] | | Yes |
|
|
|
|
#### DailyMessageStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| message_count | integer | | Yes |
|
|
|
|
#### DailyMessageStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DailyMessageStatisticItem](#dailymessagestatisticitem) ] | | Yes |
|
|
|
|
#### DailyTerminalStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| terminal_count | integer | | Yes |
|
|
|
|
#### DailyTerminalStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DailyTerminalStatisticItem](#dailyterminalstatisticitem) ] | | Yes |
|
|
|
|
#### DailyTokenCostStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| currency | string | | No |
|
|
| date | string | | Yes |
|
|
| token_count | integer | | No |
|
|
| total_price | string | | No |
|
|
|
|
#### DailyTokenCostStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DailyTokenCostStatisticItem](#dailytokencoststatisticitem) ] | | Yes |
|
|
|
|
#### DataSource
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| info_list | [InfoList](#infolist) | | Yes |
|
|
|
|
#### DataSourceApiKeyAuthProviderUnavailableError
|
|
|
|
The data-source API-key authentication provider is temporarily unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DataSourceApiKeyAuthProviderUnavailableError | | The data-source API-key authentication provider is temporarily unavailable. | |
|
|
|
|
#### DataSourceIntegrateIconResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| emoji | string | | No |
|
|
| type | string | | No |
|
|
| url | string | | No |
|
|
|
|
#### DataSourceIntegrateListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DataSourceIntegrateResponse](#datasourceintegrateresponse) ] | | Yes |
|
|
|
|
#### DataSourceIntegratePageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page_icon | [DataSourceIntegrateIconResponse](#datasourceintegrateiconresponse) | | Yes |
|
|
| page_id | string | | Yes |
|
|
| page_name | string | | Yes |
|
|
| parent_id | string | | Yes |
|
|
| type | [NotionPageType](#notionpagetype) | | Yes |
|
|
|
|
#### DataSourceIntegrateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| disabled | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| is_bound | boolean | | Yes |
|
|
| link | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| source_info | [DataSourceIntegrateWorkspaceResponse](#datasourceintegrateworkspaceresponse) | | Yes |
|
|
|
|
#### DataSourceIntegrateWorkspaceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| pages | [ [DataSourceIntegratePageResponse](#datasourceintegratepageresponse) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
| workspace_icon | string | | Yes |
|
|
| workspace_id | string | | Yes |
|
|
| workspace_name | string | | Yes |
|
|
|
|
#### DatasetAccessDeniedError
|
|
|
|
Dataset access denied.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DatasetAccessDeniedError | | Dataset access denied. | |
|
|
|
|
#### DatasetAccessMatrix
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset_id | string | | No |
|
|
| items | [ [AccessMatrixItem](#accessmatrixitem) ] | | No |
|
|
|
|
#### DatasetAndDocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| batch | string | | Yes |
|
|
| dataset | [DatasetResponse](#datasetresponse) | | Yes |
|
|
| documents | [ [DocumentResponse](#documentresponse) ] | | Yes |
|
|
|
|
#### DatasetApiKeyCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset_ids | [ string ] | | No |
|
|
| knowledge_space_ids | [ string ] | | No |
|
|
|
|
#### DatasetCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| external_knowledge_api_id | string | | No |
|
|
| external_knowledge_id | string | | No |
|
|
| indexing_technique | string | | No |
|
|
| name | string | | Yes |
|
|
| permission | [PermissionEnum](#permissionenum) | | No |
|
|
| provider | string, <br>**Default:** vendor | | No |
|
|
|
|
#### DatasetDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_count | integer | | Yes |
|
|
| author_name | string | | Yes |
|
|
| built_in_field_enabled | boolean | | Yes |
|
|
| chunk_structure | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| data_source_type | string, <br>**Available values:** "local_file", "notion_import", "online_document", "online_drive", "upload_file", "website_crawl" | | Yes |
|
|
| description | string | | Yes |
|
|
| doc_form | string | | Yes |
|
|
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
|
| document_count | integer | | Yes |
|
|
| embedding_available | boolean | | No |
|
|
| embedding_model | string | | Yes |
|
|
| embedding_model_provider | string | | Yes |
|
|
| enable_api | boolean | | Yes |
|
|
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | Connection details for external knowledge bases. Populated when `provider` is `external`; otherwise its properties are `null`. | No |
|
|
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
|
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | Icon display configuration for the knowledge base. | No |
|
|
| id | string | | Yes |
|
|
| indexing_technique | [IndexTechniqueType](#indextechniquetype) | | Yes |
|
|
| is_multimodal | boolean | | Yes |
|
|
| is_published | boolean | | Yes |
|
|
| keyword_number | integer | Keywords extracted per chunk by the economy index. | No |
|
|
| maintainer | string | | No |
|
|
| name | string | | Yes |
|
|
| permission | string, <br>**Available values:** "all_team_members", "only_me", "partial_members" | *Enum:* `"all_team_members"`, `"only_me"`, `"partial_members"` | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| pipeline_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | Retrieval configuration for the knowledge base. | Yes |
|
|
| runtime_mode | string, <br>**Available values:** "general", "rag_pipeline" | | Yes |
|
|
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | Summary index configuration. | No |
|
|
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
|
| total_available_documents | integer | | Yes |
|
|
| total_documents | integer | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| word_count | integer | | Yes |
|
|
|
|
#### DatasetDetailWithPartialMembersResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_count | integer | | Yes |
|
|
| author_name | string | | Yes |
|
|
| built_in_field_enabled | boolean | | Yes |
|
|
| chunk_structure | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| data_source_type | string, <br>**Available values:** "local_file", "notion_import", "online_document", "online_drive", "upload_file", "website_crawl" | | Yes |
|
|
| description | string | | Yes |
|
|
| doc_form | string | | Yes |
|
|
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
|
| document_count | integer | | Yes |
|
|
| embedding_available | boolean | | No |
|
|
| embedding_model | string | | Yes |
|
|
| embedding_model_provider | string | | Yes |
|
|
| enable_api | boolean | | Yes |
|
|
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | Connection details for external knowledge bases. Populated when `provider` is `external`; otherwise its properties are `null`. | No |
|
|
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
|
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | Icon display configuration for the knowledge base. | No |
|
|
| id | string | | Yes |
|
|
| indexing_technique | [IndexTechniqueType](#indextechniquetype) | | Yes |
|
|
| is_multimodal | boolean | | Yes |
|
|
| is_published | boolean | | Yes |
|
|
| keyword_number | integer | Keywords extracted per chunk by the economy index. | No |
|
|
| maintainer | string | | No |
|
|
| name | string | | Yes |
|
|
| partial_member_list | [ string ] | | No |
|
|
| permission | string, <br>**Available values:** "all_team_members", "only_me", "partial_members" | *Enum:* `"all_team_members"`, `"only_me"`, `"partial_members"` | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| pipeline_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | Retrieval configuration for the knowledge base. | Yes |
|
|
| runtime_mode | string, <br>**Available values:** "general", "rag_pipeline" | | Yes |
|
|
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | Summary index configuration. | No |
|
|
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
|
| total_available_documents | integer | | Yes |
|
|
| total_documents | integer | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| word_count | integer | | Yes |
|
|
|
|
#### DatasetDocMetadataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
|
|
#### DatasetExternalKnowledgeInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| external_knowledge_api_endpoint | string | | No |
|
|
| external_knowledge_api_id | string | | No |
|
|
| external_knowledge_api_name | string | | No |
|
|
| external_knowledge_id | string | | No |
|
|
|
|
#### DatasetExternalRetrievalModelResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| score_threshold | number | | No |
|
|
| score_threshold_enabled | boolean | | No |
|
|
| top_k | integer | | Yes |
|
|
|
|
#### DatasetIconInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| icon_url | string | | No |
|
|
|
|
#### DatasetKeywordSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_weight | number | | No |
|
|
|
|
#### DatasetListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_count | integer | | Yes |
|
|
| author_name | string | | Yes |
|
|
| built_in_field_enabled | boolean | | Yes |
|
|
| chunk_structure | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| data_source_type | string, <br>**Available values:** "local_file", "notion_import", "online_document", "online_drive", "upload_file", "website_crawl" | | Yes |
|
|
| description | string | | Yes |
|
|
| doc_form | string | | Yes |
|
|
| doc_metadata | [ [DatasetDocMetadataResponse](#datasetdocmetadataresponse) ] | | Yes |
|
|
| document_count | integer | | Yes |
|
|
| embedding_available | boolean | | No |
|
|
| embedding_model | string | | Yes |
|
|
| embedding_model_provider | string | | Yes |
|
|
| enable_api | boolean | | Yes |
|
|
| external_knowledge_info | [DatasetExternalKnowledgeInfoResponse](#datasetexternalknowledgeinforesponse) | Connection details for external knowledge bases. Populated when `provider` is `external`; otherwise its properties are `null`. | No |
|
|
| external_retrieval_model | [DatasetExternalRetrievalModelResponse](#datasetexternalretrievalmodelresponse) | | Yes |
|
|
| icon_info | [DatasetIconInfoResponse](#dataseticoninforesponse) | Icon display configuration for the knowledge base. | No |
|
|
| id | string | | Yes |
|
|
| indexing_technique | [IndexTechniqueType](#indextechniquetype) | | Yes |
|
|
| is_multimodal | boolean | | Yes |
|
|
| is_published | boolean | | Yes |
|
|
| keyword_number | integer | Keywords extracted per chunk by the economy index. | No |
|
|
| knowledge_fs_upgrade | [KnowledgeFSUpgradeDiscoveryResponse](#knowledgefsupgradediscoveryresponse) | | Yes |
|
|
| maintainer | string | | No |
|
|
| name | string | | Yes |
|
|
| partial_member_list | [ string ] | | Yes |
|
|
| permission | string, <br>**Available values:** "all_team_members", "only_me", "partial_members" | *Enum:* `"all_team_members"`, `"only_me"`, `"partial_members"` | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| pipeline_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| retrieval_model_dict | [DatasetRetrievalModelResponse](#datasetretrievalmodelresponse) | Retrieval configuration for the knowledge base. | Yes |
|
|
| runtime_mode | string, <br>**Available values:** "general", "rag_pipeline" | | Yes |
|
|
| summary_index_setting | [DatasetSummaryIndexSettingResponse](#datasetsummaryindexsettingresponse) | Summary index configuration. | No |
|
|
| tags | [ [DatasetTagResponse](#datasettagresponse) ] | | Yes |
|
|
| total_available_documents | integer | | Yes |
|
|
| total_documents | integer | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| word_count | integer | | Yes |
|
|
|
|
#### DatasetListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DatasetListItemResponse](#datasetlistitemresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### DatasetMetadataBuiltInFieldResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
|
|
#### DatasetMetadataBuiltInFieldsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| fields | [ [DatasetMetadataBuiltInFieldResponse](#datasetmetadatabuiltinfieldresponse) ] | | Yes |
|
|
|
|
#### DatasetMetadataListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
|
|
#### DatasetMetadataListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| built_in_field_enabled | boolean | | Yes |
|
|
| doc_metadata | [ [DatasetMetadataListItemResponse](#datasetmetadatalistitemresponse) ] | | Yes |
|
|
|
|
#### DatasetMetadataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
|
|
#### DatasetNameDuplicateError
|
|
|
|
The dataset name already exists. Please modify your dataset name.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DatasetNameDuplicateError | | The dataset name already exists. Please modify your dataset name. | |
|
|
|
|
#### DatasetQueryContentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| content_type | [QueryType](#querytype) | | Yes |
|
|
| file_info | [DatasetQueryFileInfoResponse](#datasetqueryfileinforesponse) | | No |
|
|
|
|
#### DatasetQueryDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| created_by_role | [CreatorUserRole](#creatoruserrole) | | Yes |
|
|
| id | string | | Yes |
|
|
| queries | [ [DatasetQueryContentResponse](#datasetquerycontentresponse) ] | | Yes |
|
|
| source | [DatasetQuerySource](#datasetquerysource) | | Yes |
|
|
| source_app_id | string | | Yes |
|
|
|
|
#### DatasetQueryFileInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| extension | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| name | string | | Yes |
|
|
| size | integer | | Yes |
|
|
| source_url | string | | Yes |
|
|
|
|
#### DatasetQueryListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DatasetQueryDetailResponse](#datasetquerydetailresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### DatasetQuerySource
|
|
|
|
Dataset query source
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DatasetQuerySource | string | Dataset query source | |
|
|
|
|
#### DatasetRerankingModelResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reranking_model_name | string | | No |
|
|
| reranking_provider_name | string | | No |
|
|
|
|
#### DatasetResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| data_source_type | string | | No |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| indexing_technique | string | | No |
|
|
| name | string | | Yes |
|
|
| permission | string | | No |
|
|
|
|
#### DatasetRetrievalModelResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reranking_enable | boolean | | Yes |
|
|
| reranking_mode | string | | No |
|
|
| reranking_model | [DatasetRerankingModelResponse](#datasetrerankingmodelresponse) | Reranking model configuration. | No |
|
|
| score_threshold | number | | No |
|
|
| score_threshold_enabled | boolean | | Yes |
|
|
| search_method | [RetrievalMethod](#retrievalmethod) | | Yes |
|
|
| top_k | integer | | Yes |
|
|
| weights | [DatasetWeightedScoreResponse](#datasetweightedscoreresponse) | | No |
|
|
|
|
#### DatasetSummaryIndexSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enable | boolean | | No |
|
|
| model_name | string | | No |
|
|
| model_provider_name | string | | No |
|
|
| summary_prompt | string | | No |
|
|
|
|
#### DatasetTagResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### DatasetUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| embedding_model | string | | No |
|
|
| embedding_model_provider | string | | No |
|
|
| external_knowledge_api_id | string | | No |
|
|
| external_knowledge_id | string | | No |
|
|
| external_retrieval_model | object | | No |
|
|
| icon_info | object | | No |
|
|
| indexing_technique | string | | No |
|
|
| is_multimodal | boolean | | No |
|
|
| name | string | | No |
|
|
| partial_member_list | [ object ] | | No |
|
|
| permission | [PermissionEnum](#permissionenum) | | No |
|
|
| retrieval_model | object | | No |
|
|
| summary_index_setting | object | | No |
|
|
|
|
#### DatasetVectorSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | | No |
|
|
| embedding_provider_name | string | | No |
|
|
| vector_weight | number | | No |
|
|
|
|
#### DatasetWeightedScoreResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_setting | [DatasetKeywordSettingResponse](#datasetkeywordsettingresponse) | Keyword search weight settings. | No |
|
|
| vector_setting | [DatasetVectorSettingResponse](#datasetvectorsettingresponse) | Semantic search weight settings. | No |
|
|
| weight_type | string | | No |
|
|
|
|
#### DatasourceContentPreviewPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
| datasource_type | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
|
|
#### DatasourceCredentialDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
|
|
#### DatasourceCredentialListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | [ [DatasourceCredentialResponse](#datasourcecredentialresponse) ] | | Yes |
|
|
|
|
#### DatasourceCredentialPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | Plugin-defined credential parameters. The schema is declared by the datasource provider. | Yes |
|
|
| name | string | | No |
|
|
|
|
#### DatasourceCredentialResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | | Yes |
|
|
| credential | object | Obfuscated plugin-defined credential parameters from the datasource provider. | Yes |
|
|
| id | string | | Yes |
|
|
| is_default | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### DatasourceCredentialUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| credentials | object | Plugin-defined credential parameters. The schema is declared by the datasource provider. | No |
|
|
| name | string | | No |
|
|
|
|
#### DatasourceCustomClientPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_params | object | Plugin-defined OAuth client parameters. The schema is declared by the datasource provider. | No |
|
|
| enable_oauth_custom_client | boolean | | No |
|
|
|
|
#### DatasourceDefaultPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
|
|
#### DatasourceEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | [I18nObject](#i18nobject) | The label of the datasource | Yes |
|
|
| identity | [DatasourceIdentity](#datasourceidentity) | | Yes |
|
|
| output_schema | object | | No |
|
|
| parameters | [ [DatasourceParameter](#datasourceparameter) ] | | No |
|
|
|
|
#### DatasourceIdentity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the datasource | Yes |
|
|
| icon | string | | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the datasource | Yes |
|
|
| name | string | The name of the datasource | Yes |
|
|
| provider | string | The provider of the datasource | Yes |
|
|
|
|
#### DatasourceNodeRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
| datasource_type | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
|
|
#### DatasourceOAuthAuthorizationQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | Credential ID to reauthorize | No |
|
|
| visibility | string | Visibility for the credential to be created. Accepts 'only_me' or 'all_team_members'; any other value falls back to 'only_me'. Ignored on reauthorization (credential_id set). | No |
|
|
|
|
#### DatasourceOAuthCallbackQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | Authorization code from OAuth provider | No |
|
|
| context_id | string | OAuth proxy context ID | No |
|
|
| error | string | Error message from OAuth provider | No |
|
|
| state | string | OAuth state parameter | No |
|
|
|
|
#### DatasourceOAuthSchemaResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
|
|
| is_oauth_custom_client_enabled | boolean | | Yes |
|
|
| is_system_oauth_params_exists | boolean | | Yes |
|
|
| oauth_custom_client_params | object | Masked plugin-defined OAuth client parameters, when configured for the tenant. | Yes |
|
|
| redirect_uri | string | | Yes |
|
|
|
|
#### DatasourceParameter
|
|
|
|
Overrides type
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_generate | [PluginParameterAutoGenerate](#pluginparameterautogenerate) | | No |
|
|
| default | number<br>integer<br>string<br>boolean<br>[ object ]<br>object | | No |
|
|
| description | [I18nObject](#i18nobject) | The description of the parameter | Yes |
|
|
| label | [I18nObject](#i18nobject) | The label presented to the user | Yes |
|
|
| max | number<br>integer | | No |
|
|
| min | number<br>integer | | No |
|
|
| name | string | The name of the parameter | Yes |
|
|
| options | [ [PluginParameterOption](#pluginparameteroption) ] | | No |
|
|
| placeholder | [I18nObject](#i18nobject) | The placeholder presented to the user | No |
|
|
| precision | integer | | No |
|
|
| required | boolean | | No |
|
|
| scope | string | | No |
|
|
| template | [PluginParameterTemplate](#pluginparametertemplate) | | No |
|
|
| type | [DatasourceParameterType](#datasourceparametertype) | The type of the parameter | Yes |
|
|
|
|
#### DatasourceParameterType
|
|
|
|
removes TOOLS_SELECTOR from PluginParameterType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DatasourceParameterType | string | removes TOOLS_SELECTOR from PluginParameterType | |
|
|
|
|
#### DatasourceProviderAuthListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | [ [DatasourceProviderAuthResponse](#datasourceproviderauthresponse) ] | | Yes |
|
|
|
|
#### DatasourceProviderAuthResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | | Yes |
|
|
| credential_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
|
|
| credentials_list | [ [DatasourceCredentialResponse](#datasourcecredentialresponse) ] | | Yes |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| icon | string | | Yes |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| name | string | | Yes |
|
|
| oauth_schema | [DatasourceOAuthSchemaResponse](#datasourceoauthschemaresponse) | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### DatasourceProviderEntity
|
|
|
|
Datasource provider entity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | | No |
|
|
| identity | [DatasourceProviderIdentity](#datasourceprovideridentity) | | Yes |
|
|
| oauth_schema | [OAuthSchema](#oauthschema) | | No |
|
|
| provider_type | [DatasourceProviderType](#datasourceprovidertype) | | Yes |
|
|
|
|
#### DatasourceProviderEntityWithPlugin
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | | No |
|
|
| datasources | [ [DatasourceEntity](#datasourceentity) ] | | No |
|
|
| identity | [DatasourceProviderIdentity](#datasourceprovideridentity) | | Yes |
|
|
| oauth_schema | [OAuthSchema](#oauthschema) | | No |
|
|
| provider_type | [DatasourceProviderType](#datasourceprovidertype) | | Yes |
|
|
|
|
#### DatasourceProviderIdentity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the tool | Yes |
|
|
| description | [I18nObject](#i18nobject) | The description of the tool | Yes |
|
|
| icon | string | The icon of the tool | Yes |
|
|
| label | [I18nObject](#i18nobject) | The label of the tool | Yes |
|
|
| name | string | The name of the tool | Yes |
|
|
| tags | [ [ToolLabelEnum](#toollabelenum) ] | The tags of the tool | No |
|
|
|
|
#### DatasourceProviderType
|
|
|
|
Enum class for datasource provider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DatasourceProviderType | string | Enum class for datasource provider | |
|
|
|
|
#### DatasourceUpdateNamePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### DatasourceVariablesPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasource_info | object | | Yes |
|
|
| datasource_type | string | | Yes |
|
|
| start_node_id | string | | Yes |
|
|
| start_node_title | string | | Yes |
|
|
|
|
#### DebugChannel
|
|
|
|
Delivery selection for editor debugging, resolved to current channel configuration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DebugChannel | string | Delivery selection for editor debugging, resolved to current channel configuration. | |
|
|
|
|
#### DebugModeConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channels | [ [DebugChannel](#debugchannel) ] | | Yes |
|
|
| enabled | boolean | | No |
|
|
|
|
#### DeclaredArrayItem
|
|
|
|
Per-item shape for an ``array``-typed declared output.
|
|
|
|
The PRD output configuration section limits arrays to one level; nested arrays
|
|
are rejected so the runtime type checker and JSON Schema stay easy to reason
|
|
about. Stage 4 §4.2.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| children | [ { **"array_item"**: , **"children"**: [ object ], **"description"**: , **"file"**: , **"name"**: string, **"required"**: boolean, **"type"**: string, <br>**Available values:** "array", "boolean", "file", "number", "object", "string" } ] | | No |
|
|
| description | string | | No |
|
|
| type | [DeclaredOutputType](#declaredoutputtype) | | Yes |
|
|
|
|
#### DeclaredOutputCheckConfig
|
|
|
|
File-output content check via a model-based comparison against a benchmark file.
|
|
|
|
Per the PRD output configuration section, output checks are **file-only** and optional. Stage 4 §4.3.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| benchmark_file_ref | [AgentFileRefConfig](#agentfilerefconfig) | | No |
|
|
| enabled | boolean | | No |
|
|
| model_ref | [AgentSoulModelConfig](#agentsoulmodelconfig) | | No |
|
|
| prompt | string | | No |
|
|
|
|
#### DeclaredOutputConfig
|
|
|
|
One declared output of a Workflow Agent Node.
|
|
|
|
Stage 4 normalizes the shape: ``check`` is singular (was ``checks: list`` in
|
|
stage 3), and ``failure_strategy`` defaults to a populated value so runtime
|
|
code can call ``output.failure_strategy.on_failure`` without None-guards.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| array_item | [DeclaredArrayItem](#declaredarrayitem) | | No |
|
|
| check | [DeclaredOutputCheckConfig](#declaredoutputcheckconfig) | | No |
|
|
| children | [ { **"array_item"**: , **"children"**: [ object ], **"description"**: , **"file"**: , **"name"**: string, **"required"**: boolean, **"type"**: string, <br>**Available values:** "array", "boolean", "file", "number", "object", "string" } ] | | No |
|
|
| description | string | | No |
|
|
| failure_strategy | [DeclaredOutputFailureStrategy](#declaredoutputfailurestrategy) | | No |
|
|
| file | [DeclaredOutputFileConfig](#declaredoutputfileconfig) | | No |
|
|
| id | string | | No |
|
|
| name | string | | Yes |
|
|
| required | boolean, <br>**Default:** true | | No |
|
|
| type | [DeclaredOutputType](#declaredoutputtype) | | Yes |
|
|
|
|
#### DeclaredOutputFailureStrategy
|
|
|
|
Per-output failure handling.
|
|
|
|
A single strategy applies to both ``type_check`` and ``output_check`` failures
|
|
(PRD does not distinguish them at the UX level). Stage 4 §4.4.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_value | | | No |
|
|
| on_failure | [OutputErrorStrategy](#outputerrorstrategy) | | No |
|
|
| retry | [DeclaredOutputRetryConfig](#declaredoutputretryconfig) | | No |
|
|
|
|
#### DeclaredOutputFileConfig
|
|
|
|
File-type output metadata. Both lists empty means "any file accepted".
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| extensions | [ string ] | | No |
|
|
| mime_types | [ string ] | | No |
|
|
|
|
#### DeclaredOutputRetryConfig
|
|
|
|
Per-output retry configuration that mirrors ``graphon.RetryConfig`` shape.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| max_retries | integer | | No |
|
|
| retry_interval_ms | integer | | No |
|
|
|
|
#### DeclaredOutputType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DeclaredOutputType | string | | |
|
|
|
|
#### DefaultBlockConfigItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### DefaultBlockConfigQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| q | string | | No |
|
|
|
|
#### DefaultBlockConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DefaultBlockConfigResponse | object | | |
|
|
|
|
#### DefaultBlockConfigsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DefaultBlockConfigsResponse | array | | |
|
|
|
|
#### DefaultModelDataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [DefaultModelResponse](#defaultmodelresponse) | | No |
|
|
|
|
#### DefaultModelResponse
|
|
|
|
Default model entity.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| provider | [SimpleProviderEntityResponse](#simpleproviderentityresponse) | | Yes |
|
|
|
|
#### DefaultValue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| key | string | | Yes |
|
|
| type | [DefaultValueType](#defaultvaluetype) | | Yes |
|
|
| value | | | No |
|
|
|
|
#### DefaultValueType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DefaultValueType | string | | |
|
|
|
|
#### DeleteIMBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
|
|
#### DeletedTool
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| provider_id | string | | Yes |
|
|
| tool_name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### DeploymentEdition
|
|
|
|
Enum representing the deployment edition of the platform.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DeploymentEdition | string | Enum representing the deployment edition of the platform. | |
|
|
|
|
#### DingTalkCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | DingTalk application client identifier. | Yes |
|
|
| client_secret | [_RequiredSecret](#_requiredsecret) | DingTalk application client secret. | Yes |
|
|
| corp_id | string | DingTalk corporation identifier. | Yes |
|
|
| provider | string | DingTalk credential discriminator. | Yes |
|
|
|
|
#### DingTalkCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | | Yes |
|
|
| client_secret | [Redacted](#redacted) | | Yes |
|
|
| corp_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### DingTalkCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | [_Identifier](#_identifier)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| client_secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| corp_id | [_Identifier](#_identifier)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### DismissNotificationPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| notification_id | string | | Yes |
|
|
|
|
#### DocumentAlreadyFinishedError
|
|
|
|
The document has been processed. Please refresh the page or go to the document details.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DocumentAlreadyFinishedError | | The document has been processed. Please refresh the page or go to the document details. | |
|
|
|
|
#### DocumentBatchDownloadZipPayload
|
|
|
|
Request payload for bulk downloading documents as a zip archive.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_ids | [ string (uuid) ] | List of document IDs to include in the ZIP download. | Yes |
|
|
|
|
#### DocumentDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archived | boolean | | No |
|
|
| average_segment_length | number | | No |
|
|
| completed_at | integer | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| created_from | string | | No |
|
|
| data_source_detail_dict | [DocumentSourceDetailResponse](#documentsourcedetailresponse) | | No |
|
|
| data_source_info | object | | No |
|
|
| data_source_type | string | | No |
|
|
| dataset_process_rule | [DocumentProcessRuleResponse](#documentprocessruleresponse) | | No |
|
|
| dataset_process_rule_id | string | | No |
|
|
| disabled_at | integer | | No |
|
|
| disabled_by | string | | No |
|
|
| display_status | string | | No |
|
|
| doc_form | string | | No |
|
|
| doc_language | string | | No |
|
|
| doc_metadata | [ [DocumentMetadataResponse](#documentmetadataresponse) ] | | No |
|
|
| doc_type | string | | No |
|
|
| document_process_rule | [DocumentProcessRuleResponse](#documentprocessruleresponse) | | No |
|
|
| enabled | boolean | | No |
|
|
| error | string | | No |
|
|
| hit_count | integer | | No |
|
|
| id | string | | Yes |
|
|
| indexing_latency | number | | No |
|
|
| indexing_status | string | | No |
|
|
| name | string | | No |
|
|
| need_summary | boolean | | No |
|
|
| position | integer | | No |
|
|
| segment_count | integer | | No |
|
|
| tokens | integer | | No |
|
|
| updated_at | integer | | No |
|
|
|
|
#### DocumentIndexingError
|
|
|
|
The document is being processed and cannot be edited.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DocumentIndexingError | | The document is being processed and cannot be edited. | |
|
|
|
|
#### DocumentMetadataOperation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string (uuid) | Document ID whose metadata should be updated. | Yes |
|
|
| metadata_list | [ [MetadataDetail](#metadatadetail) ] | Metadata fields to update. | Yes |
|
|
| partial_update | boolean | Whether to partially update metadata, keeping existing values for unspecified fields. | No |
|
|
|
|
#### DocumentMetadataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
| value | string<br>integer<br>number | | Yes |
|
|
|
|
#### DocumentMetadataUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| doc_metadata | | | No |
|
|
| doc_type | string | | No |
|
|
|
|
#### DocumentPipelineExecutionLogResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasource_info | [JsonValue](#jsonvalue) | | No |
|
|
| datasource_node_id | string | | No |
|
|
| datasource_type | string | | No |
|
|
| input_data | [JsonValue](#jsonvalue) | | No |
|
|
|
|
#### DocumentPreProcessingRuleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
|
|
#### DocumentProcessRuleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mode | string | | Yes |
|
|
| rules | [DocumentProcessRulesResponse](#documentprocessrulesresponse) | | No |
|
|
|
|
#### DocumentProcessRulesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| parent_mode | string, <br>**Available values:** "full-doc", "paragraph" | | No |
|
|
| pre_processing_rules | [ [DocumentPreProcessingRuleResponse](#documentpreprocessingruleresponse) ] | | No |
|
|
| segmentation | [DocumentSegmentationResponse](#documentsegmentationresponse) | | No |
|
|
| subchunk_segmentation | [DocumentSegmentationResponse](#documentsegmentationresponse) | | No |
|
|
|
|
#### DocumentRenamePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
|
|
#### DocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archived | boolean | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| created_from | string | | No |
|
|
| data_source_detail_dict | [DocumentSourceDetailResponse](#documentsourcedetailresponse) | | Yes |
|
|
| data_source_info | object | | No |
|
|
| data_source_type | string | | No |
|
|
| dataset_process_rule_id | string | | No |
|
|
| disabled_at | integer | | No |
|
|
| disabled_by | string | | No |
|
|
| display_status | string | | No |
|
|
| doc_form | string | | No |
|
|
| doc_metadata | [ [DocumentMetadataResponse](#documentmetadataresponse) ] | | No |
|
|
| enabled | boolean | | No |
|
|
| error | string | | No |
|
|
| hit_count | integer | | No |
|
|
| id | string | | Yes |
|
|
| indexing_status | string | | No |
|
|
| name | string | | Yes |
|
|
| need_summary | boolean | | No |
|
|
| position | integer | | No |
|
|
| summary_index_status | string | | No |
|
|
| tokens | integer | | No |
|
|
| word_count | integer | | No |
|
|
|
|
#### DocumentRetryPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_ids | [ string ] | | Yes |
|
|
|
|
#### DocumentSegmentationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chunk_overlap | integer | | No |
|
|
| max_tokens | integer | | Yes |
|
|
| separator | string, <br>**Default:**
|
|
| | No |
|
|
|
|
#### DocumentSourceDetailResponse
|
|
|
|
The uploaded file for file documents; Notion and website documents repeat their source info.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| upload_file | [DocumentUploadFileDetailResponse](#documentuploadfiledetailresponse) | | No |
|
|
|
|
#### DocumentStatusListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] | | Yes |
|
|
|
|
#### DocumentStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cleaning_completed_at | integer | | Yes |
|
|
| completed_at | integer | | Yes |
|
|
| completed_segments | integer | | No |
|
|
| error | string | | Yes |
|
|
| error_code | string | | No |
|
|
| estimated_vector_space_mb | integer | | No |
|
|
| id | string | | Yes |
|
|
| indexing_status | string, <br>**Available values:** "cleaning", "completed", "error", "indexing", "parsing", "paused", "splitting", "waiting" | *Enum:* `"cleaning"`, `"completed"`, `"error"`, `"indexing"`, `"parsing"`, `"paused"`, `"splitting"`, `"waiting"` | Yes |
|
|
| parsing_completed_at | integer | | Yes |
|
|
| paused_at | integer | | Yes |
|
|
| processing_started_at | integer | | Yes |
|
|
| splitting_completed_at | integer | | Yes |
|
|
| stopped_at | integer | | Yes |
|
|
| total_segments | integer | | No |
|
|
| vector_space_limit_mb | integer | | No |
|
|
|
|
#### DocumentSummaryStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| summaries | [ [SummaryEntryResponse](#summaryentryresponse) ] | | Yes |
|
|
| summary_status | [SummaryStatusResponse](#summarystatusresponse) | | Yes |
|
|
| total_segments | integer | | Yes |
|
|
|
|
#### DocumentUploadFileDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | number | | Yes |
|
|
| created_by | string | | Yes |
|
|
| extension | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | Yes |
|
|
|
|
#### DocumentWithSegmentsListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DocumentWithSegmentsResponse](#documentwithsegmentsresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### DocumentWithSegmentsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archived | boolean | | No |
|
|
| completed_segments | integer | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| created_from | string | | No |
|
|
| data_source_detail_dict | [DocumentSourceDetailResponse](#documentsourcedetailresponse) | | Yes |
|
|
| data_source_info | object | | No |
|
|
| data_source_type | string | | No |
|
|
| dataset_process_rule_id | string | | No |
|
|
| disabled_at | integer | | No |
|
|
| disabled_by | string | | No |
|
|
| display_status | string | | No |
|
|
| doc_form | string | | No |
|
|
| doc_metadata | [ [DocumentMetadataResponse](#documentmetadataresponse) ] | | No |
|
|
| enabled | boolean | | No |
|
|
| error | string | | No |
|
|
| hit_count | integer | | No |
|
|
| id | string | | Yes |
|
|
| indexing_status | string | | No |
|
|
| name | string | | Yes |
|
|
| need_summary | boolean | | No |
|
|
| position | integer | | No |
|
|
| process_rule_dict | [DocumentProcessRuleResponse](#documentprocessruleresponse) | | No |
|
|
| summary_index_status | string | | No |
|
|
| tokens | integer | | No |
|
|
| total_segments | integer | | No |
|
|
| word_count | integer | | No |
|
|
|
|
#### DraftWorkflowNodeRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
| query | string | | No |
|
|
|
|
#### DraftWorkflowNotExistError
|
|
|
|
Draft workflow need to be initialized.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DraftWorkflowNotExistError | | Draft workflow need to be initialized. | |
|
|
|
|
#### DraftWorkflowNotSyncError
|
|
|
|
Workflow graph might have been modified, please refresh and resubmit.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| DraftWorkflowNotSyncError | | Workflow graph might have been modified, please refresh and resubmit. | |
|
|
|
|
#### DraftWorkflowRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
|
|
#### DraftWorkflowSyncPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_variables | [ object ] | | No |
|
|
| environment_variables | [ object ] | | No |
|
|
| features | object | | No |
|
|
| graph | object | | Yes |
|
|
| hash | string | | No |
|
|
| rag_pipeline_variables | [ object ] | | No |
|
|
|
|
#### DraftWorkflowTriggerRunAllPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_ids | [ string ] | | Yes |
|
|
|
|
#### DraftWorkflowTriggerRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_id | string | | Yes |
|
|
|
|
#### DslImportWarning
|
|
|
|
Portable DSL reference that could not be restored in the target workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| details | object | | No |
|
|
| message | string | | Yes |
|
|
| path | string | | Yes |
|
|
|
|
#### DynamicEmail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| selector | [ string ] | | Yes |
|
|
| type | string, <br>**Default:** dynamic_email | | No |
|
|
|
|
#### EducationActivateFailedError
|
|
|
|
We couldn't activate your education discount.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EducationActivateFailedError | | We couldn't activate your education discount. | |
|
|
|
|
#### EducationActivateLimitError
|
|
|
|
Rate limit exceeded
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EducationActivateLimitError | | Rate limit exceeded | |
|
|
|
|
#### EducationActivatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| institution | string | | Yes |
|
|
| role | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### EducationActivateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message | string | | Yes |
|
|
|
|
#### EducationAutocompleteQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keywords | string | | Yes |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer | | No |
|
|
|
|
#### EducationAutocompleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| curr_page | integer | | Yes |
|
|
| data | [ string ] | | Yes |
|
|
| has_next | boolean | | Yes |
|
|
|
|
#### EducationModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| activated | boolean | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
|
|
#### EducationStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allow_refresh | boolean | | Yes |
|
|
| expire_at | integer | | Yes |
|
|
| is_student | boolean | | Yes |
|
|
| result | boolean | | Yes |
|
|
|
|
#### EducationVerifyEligibleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| status | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### EducationVerifyFailedError
|
|
|
|
We couldn't verify your education status.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EducationVerifyFailedError | | We couldn't verify your education status. | |
|
|
|
|
#### EducationVerifyLimitError
|
|
|
|
Rate limit exceeded
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EducationVerifyLimitError | | Rate limit exceeded | |
|
|
|
|
#### EducationVerifyNotEligibleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| status | string | | Yes |
|
|
|
|
#### EducationVerifyResponse
|
|
|
|
Education verification result: a token for an eligible account, none for an ineligible one.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EducationVerifyResponse | [EducationVerifyEligibleResponse](#educationverifyeligibleresponse)<br>[EducationVerifyNotEligibleResponse](#educationverifynoteligibleresponse) | Education verification result: a token for an eligible account, none for an ineligible one. | |
|
|
|
|
#### EmailAlreadyInUseError
|
|
|
|
A user with this email already exists.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailAlreadyInUseError | | A user with this email already exists. | |
|
|
|
|
#### EmailChangeLimitError
|
|
|
|
Too many failed email change attempts. Please try again in 24 hours.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailChangeLimitError | | Too many failed email change attempts. Please try again in 24 hours. | |
|
|
|
|
#### EmailChangeRateLimitExceededError
|
|
|
|
Too many email change emails have been sent. Please try again in {minutes} minutes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailChangeRateLimitExceededError | | Too many email change emails have been sent. Please try again in {minutes} minutes. | |
|
|
|
|
#### EmailChannelCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [EmailProviderCredentials](#emailprovidercredentials) | | Yes |
|
|
| sender_email | string | | Yes |
|
|
| sender_name | [_SenderName](#_sendername) | | Yes |
|
|
|
|
#### EmailChannelDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [ResendCredentialsResponse](#resendcredentialsresponse) | | Yes |
|
|
| sender_email | string | | Yes |
|
|
| sender_name | string | | Yes |
|
|
| summary | [ChannelSummary](#channelsummary) | | Yes |
|
|
|
|
#### EmailChannelMutationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| summary | [ChannelSummary](#channelsummary) | | Yes |
|
|
|
|
#### EmailChannelTestPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [EmailProviderCredentials](#emailprovidercredentials) | | Yes |
|
|
| sender_email | string | | Yes |
|
|
| sender_name | [_SenderName](#_sendername) | | Yes |
|
|
|
|
#### EmailChannelUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [EmailProviderCredentialsUpdateInput](#emailprovidercredentialsupdateinput) | | Yes |
|
|
| expected_config_version | [ConfigVersion](#configversion) | | Yes |
|
|
| sender_email | string<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| sender_name | [_SenderName](#_sendername)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
|
|
#### EmailCodeAccountDeletionRateLimitExceededError
|
|
|
|
Too many account deletion emails have been sent. Please try again in {minutes} minutes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailCodeAccountDeletionRateLimitExceededError | | Too many account deletion emails have been sent. Please try again in {minutes} minutes. | |
|
|
|
|
#### EmailCodeError
|
|
|
|
Email code is invalid or expired.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailCodeError | | Email code is invalid or expired. | |
|
|
|
|
#### EmailCodeLoginLimitError
|
|
|
|
Too many incorrect password attempts. Please try again later.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailCodeLoginLimitError | | Too many incorrect password attempts. Please try again later. | |
|
|
|
|
#### EmailCodeLoginPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| email | string | | Yes |
|
|
| language | string | | No |
|
|
| timezone | string | | No |
|
|
| token | string (uuid) | | Yes |
|
|
| turnstile_token | string | Cloudflare Turnstile token for email-code verification. | No |
|
|
|
|
#### EmailCodeLoginRateLimitExceededError
|
|
|
|
Too many login emails have been sent. Please try again in {minutes} minutes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailCodeLoginRateLimitExceededError | | Too many login emails have been sent. Please try again in {minutes} minutes. | |
|
|
|
|
#### EmailCodeLoginServiceUnavailableError
|
|
|
|
Email code verification is temporarily unavailable. Please try again later.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailCodeLoginServiceUnavailableError | | Email code verification is temporarily unavailable. Please try again later. | |
|
|
|
|
#### EmailCodeSendPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| language | string | | No |
|
|
| turnstile_token | string | Cloudflare Turnstile token. Required at runtime for Dify Cloud. | No |
|
|
|
|
#### EmailDeliveryConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| body | string | | Yes |
|
|
| debug_mode | boolean | | No |
|
|
| recipients | [EmailRecipients](#emailrecipients) | | Yes |
|
|
| subject | string | | Yes |
|
|
|
|
#### EmailDeliveryMethod
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | [EmailDeliveryConfig](#emaildeliveryconfig) | | Yes |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| id | string (uuid) | | No |
|
|
| type | string, <br>**Default:** email | | No |
|
|
|
|
#### EmailDomainSuspendedError
|
|
|
|
This email domain has been suspended.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailDomainSuspendedError | | This email domain has been suspended. | |
|
|
|
|
#### EmailPasswordResetLimitError
|
|
|
|
Too many failed password reset attempts. Please try again in 24 hours.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailPasswordResetLimitError | | Too many failed password reset attempts. Please try again in 24 hours. | |
|
|
|
|
#### EmailPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| language | string | | No |
|
|
|
|
#### EmailProviderCredentials
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailProviderCredentials | [ResendCredentials](#resendcredentials) | | |
|
|
|
|
#### EmailProviderCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailProviderCredentialsUpdateInput | [ResendCredentialsUpdateInput](#resendcredentialsupdateinput) | | |
|
|
|
|
#### EmailProviderType
|
|
|
|
Email provider supported by organization-level Human Input delivery.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailProviderType | string | Email provider supported by organization-level Human Input delivery. | |
|
|
|
|
#### EmailRecipients
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| include_bound_group | boolean | | No |
|
|
| items | [ [BoundRecipient](#boundrecipient)<br>[ExternalRecipient](#externalrecipient) ] | | No |
|
|
|
|
#### EmailRegisterLimitError
|
|
|
|
Too many failed email register attempts. Please try again in 24 hours.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailRegisterLimitError | | Too many failed email register attempts. Please try again in 24 hours. | |
|
|
|
|
#### EmailRegisterRateLimitExceededError
|
|
|
|
Too many email register emails have been sent. Please try again in {minutes} minutes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailRegisterRateLimitExceededError | | Too many email register emails have been sent. Please try again in {minutes} minutes. | |
|
|
|
|
#### EmailRegisterResetPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string | | No |
|
|
| new_password | string | | Yes |
|
|
| password_confirm | string | | Yes |
|
|
| timezone | string | | No |
|
|
| token | string | | Yes |
|
|
|
|
#### EmailRegisterResetResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [EmailRegisterTokenPairResponse](#emailregistertokenpairresponse) | | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### EmailRegisterSendPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | Email address | Yes |
|
|
| language | string | Language code | No |
|
|
|
|
#### EmailRegisterTokenPairResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_token | string | | Yes |
|
|
| csrf_token | string | | Yes |
|
|
| refresh_token | string | | Yes |
|
|
|
|
#### EmailRegisterValidityPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| email | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### EmailSendIpLimitError
|
|
|
|
Too many emails have been sent from this IP address recently. Please try again later.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmailSendIpLimitError | | Too many emails have been sent from this IP address recently. Please try again later. | |
|
|
|
|
#### EmptyObjectResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EmptyObjectResponse | object | | |
|
|
|
|
#### Endpoint
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
|
|
#### EndpointCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| settings | object | | Yes |
|
|
|
|
#### EndpointDeclaration
|
|
|
|
declaration of an endpoint
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| hidden | boolean | | No |
|
|
| method | string | | Yes |
|
|
| path | string | | Yes |
|
|
|
|
#### EndpointDeclarationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| hidden | boolean | | No |
|
|
| method | string | | Yes |
|
|
| path | string | | Yes |
|
|
|
|
#### EndpointIdPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| endpoint_id | string | | Yes |
|
|
|
|
#### EndpointListForPluginQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page | integer | | Yes |
|
|
| page_size | integer | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
|
|
#### EndpointListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | | Yes |
|
|
| declaration | [EndpointProviderDeclarationResponse](#endpointproviderdeclarationresponse) | | No |
|
|
| enabled | boolean | | Yes |
|
|
| expired_at | dateTime | | Yes |
|
|
| hook_id | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| settings | object | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### EndpointListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page | integer | | Yes |
|
|
| page_size | integer | | Yes |
|
|
|
|
#### EndpointListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| endpoints | [ [EndpointListItemResponse](#endpointlistitemresponse) ] | Endpoint information | Yes |
|
|
|
|
#### EndpointMutationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| success | boolean | Always true on success. Failures are returned as HTTP errors. | Yes |
|
|
|
|
#### EndpointProviderConfigI18nResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| en_US | string | | Yes |
|
|
| ja_JP | string | | No |
|
|
| pt_BR | string | | No |
|
|
| zh_Hans | string | | No |
|
|
|
|
#### EndpointProviderConfigOptionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | [EndpointProviderConfigI18nResponse](#endpointproviderconfigi18nresponse) | | Yes |
|
|
| value | string | | Yes |
|
|
|
|
#### EndpointProviderConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | integer<br>string<br>number<br>boolean | | No |
|
|
| help | [EndpointProviderConfigI18nResponse](#endpointproviderconfigi18nresponse) | | No |
|
|
| label | [EndpointProviderConfigI18nResponse](#endpointproviderconfigi18nresponse) | | No |
|
|
| multiple | boolean | | No |
|
|
| name | string | | Yes |
|
|
| options | [ [EndpointProviderConfigOptionResponse](#endpointproviderconfigoptionresponse) ] | | No |
|
|
| placeholder | [EndpointProviderConfigI18nResponse](#endpointproviderconfigi18nresponse) | | No |
|
|
| required | boolean | | No |
|
|
| scope | [EndpointProviderConfigScope](#endpointproviderconfigscope) | | No |
|
|
| type | [ProviderConfigType](#providerconfigtype) | | Yes |
|
|
| url | string | | No |
|
|
|
|
#### EndpointProviderConfigScope
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EndpointProviderConfigScope | string | | |
|
|
|
|
#### EndpointProviderDeclaration
|
|
|
|
declaration of an endpoint group
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| endpoints | [ [EndpointDeclaration](#endpointdeclaration) ] | | No |
|
|
| settings | [ [ProviderConfig](#providerconfig) ] | | No |
|
|
|
|
#### EndpointProviderDeclarationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| endpoints | [ [EndpointDeclarationResponse](#endpointdeclarationresponse) ] | | No |
|
|
| settings | [ [EndpointProviderConfigResponse](#endpointproviderconfigresponse) ] | | No |
|
|
|
|
#### EndpointSettingsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| settings | object | | Yes |
|
|
|
|
#### EndpointUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| settings | object | | Yes |
|
|
|
|
#### EnvironmentVariableItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| id | string | | No |
|
|
| name | string | | No |
|
|
| value | | | No |
|
|
| value_type | string | | No |
|
|
|
|
#### EnvironmentVariableItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| editable | boolean | | Yes |
|
|
| edited | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| selector | [ string ] | | Yes |
|
|
| type | string | | Yes |
|
|
| value | | | Yes |
|
|
| value_type | string | | Yes |
|
|
| visible | boolean | | Yes |
|
|
|
|
#### EnvironmentVariableListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [EnvironmentVariableItemResponse](#environmentvariableitemresponse) ] | | Yes |
|
|
|
|
#### EnvironmentVariableUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deleted_environment_variable_ids | [ string ] | Environment variable IDs to delete when patch is true | No |
|
|
| environment_variables | [ [EnvironmentVariableItemPayload](#environmentvariableitempayload) ] | Environment variables for the draft workflow | Yes |
|
|
| patch | boolean | Treat environment_variables as per-ID upserts instead of replacing the full collection | No |
|
|
|
|
#### ErrorDocsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [DocumentStatusResponse](#documentstatusresponse) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### ErrorMessageResponse
|
|
|
|
Legacy ``{"error": message}`` body a few endpoints return instead of the standard error body.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | Yes |
|
|
|
|
#### ErrorResponse
|
|
|
|
Documented non-2xx body emitted by ``register_external_error_handlers``.
|
|
|
|
``params`` and ``details`` appear only on the errors that set them. The schema
|
|
stays open because ``HTTPException.data`` may carry extra keys.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| details | object | | No |
|
|
| message | string | | Yes |
|
|
| params | string | | No |
|
|
| status | integer | | Yes |
|
|
|
|
#### ErrorStrategy
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ErrorStrategy | string | | |
|
|
|
|
#### EventApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | [I18nObject](#i18nobject) | The description of the trigger | Yes |
|
|
| identity | [EventIdentity](#eventidentity) | The identity of the trigger | Yes |
|
|
| name | string | The name of the trigger | Yes |
|
|
| output_schema | object | The output schema of the trigger | Yes |
|
|
| parameters | [ [EventParameter](#eventparameter) ] | The parameters of the trigger | Yes |
|
|
|
|
#### EventEntity
|
|
|
|
The configuration of an event
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | [I18nObject](#i18nobject) | The description of the event | Yes |
|
|
| identity | [EventIdentity](#eventidentity) | | Yes |
|
|
| output_schema | object | The output schema that this event produces | No |
|
|
| parameters | [ [EventParameter](#eventparameter) ] | The parameters of the event | No |
|
|
|
|
#### EventIdentity
|
|
|
|
The identity of the event
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the event | Yes |
|
|
| label | [I18nObject](#i18nobject) | The label of the event | Yes |
|
|
| name | string | The name of the event | Yes |
|
|
| provider | string | The provider of the event | No |
|
|
|
|
#### EventParameter
|
|
|
|
The parameter of the event
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_generate | [PluginParameterAutoGenerate](#pluginparameterautogenerate) | The auto generate of the parameter | No |
|
|
| default | integer<br>number<br>string<br>[ object ] | | No |
|
|
| description | [I18nObject](#i18nobject) | | No |
|
|
| label | [I18nObject](#i18nobject) | The label presented to the user | Yes |
|
|
| max | number<br>integer | | No |
|
|
| min | number<br>integer | | No |
|
|
| multiple | boolean | Whether the parameter is multiple select, only valid for select or dynamic-select type | No |
|
|
| name | string | The name of the parameter | Yes |
|
|
| options | [ [PluginParameterOption](#pluginparameteroption) ] | | No |
|
|
| precision | integer | | No |
|
|
| required | boolean | | No |
|
|
| scope | string | | No |
|
|
| template | [PluginParameterTemplate](#pluginparametertemplate) | The template of the parameter | No |
|
|
| type | [EventParameterType](#eventparametertype) | | Yes |
|
|
|
|
#### EventParameterType
|
|
|
|
The type of the parameter
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EventParameterType | string | The type of the parameter | |
|
|
|
|
#### EventStreamResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| EventStreamResponse | string | | |
|
|
|
|
#### ExecutionContentType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ExecutionContentType | string | | |
|
|
|
|
#### ExpiredError
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ExpiredError | | | |
|
|
|
|
#### ExploreAppMetaResponse
|
|
|
|
Metadata consumed by the installed-app chat UI.
|
|
|
|
Built-in tool icons are URL strings; API-based tool icons are provider-defined payload objects.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tool_icons | object | | No |
|
|
|
|
#### ExploreMessageInfiniteScrollPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ExploreMessageListItem](#exploremessagelistitem) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
|
|
#### ExploreMessageListItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_thoughts | [ [AgentThought](#agentthought) ] | | Yes |
|
|
| answer | string | | Yes |
|
|
| answer_tokens | integer | | No |
|
|
| conversation_id | string (uuid) | | Yes |
|
|
| created_at | integer | | No |
|
|
| currency | string | | No |
|
|
| error | string | | No |
|
|
| extra_contents | [ [HumanInputContent](#humaninputcontent) ] | | Yes |
|
|
| feedback | [SimpleFeedback](#simplefeedback) | | No |
|
|
| id | string (uuid) | | Yes |
|
|
| inputs | object | | Yes |
|
|
| message_files | [ [MessageFile](#messagefile) ] | | Yes |
|
|
| message_tokens | integer | | No |
|
|
| metadata | [JSONValueType](#jsonvaluetype) | | No |
|
|
| parent_message_id | string | | No |
|
|
| provider_response_latency | float | | No |
|
|
| query | string | | Yes |
|
|
| retriever_resources | [ [RetrieverResource](#retrieverresource) ] | | Yes |
|
|
| status | string | | Yes |
|
|
| total_price | string | | No |
|
|
| total_tokens | integer | | Yes |
|
|
|
|
#### ExternalApiTemplateListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Search keyword | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of items per page | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
|
|
#### ExternalContactCreateRequest
|
|
|
|
Request body for creating or updating one external contact.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| email | string | Primary email used for delivery and identity verification. | Yes |
|
|
| name | string | Display name shown in the contact directory. | Yes |
|
|
|
|
#### ExternalContactCreateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContact](#humaninputcontact) | The created external contact. | Yes |
|
|
|
|
#### ExternalContactUpdateRequest
|
|
|
|
Request body for creating or updating one external contact.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| email | string | | No |
|
|
| name | string | | No |
|
|
|
|
#### ExternalContactUpdateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContact](#humaninputcontact) | The updated external contact. Fields are values after updating. | Yes |
|
|
|
|
#### ExternalDatasetCreatePayload
|
|
|
|
Validated fields required to create an external dataset binding.
|
|
|
|
The console controller owns HTTP concerns, but the service also needs this
|
|
contract when creating the tenant-scoped dataset and external knowledge
|
|
binding. Keep it outside controllers so service imports do not depend on
|
|
Flask blueprint initialization.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| external_knowledge_api_id | string | | Yes |
|
|
| external_knowledge_id | string | | Yes |
|
|
| external_retrieval_model | object | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### ExternalHitTestingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| external_retrieval_model | object | | No |
|
|
| metadata_filtering_conditions | object | | No |
|
|
| query | string | | Yes |
|
|
|
|
#### ExternalHitTestingQueryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
|
|
#### ExternalHitTestingRecordResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| metadata | object | | No |
|
|
| score | number | | No |
|
|
| title | string | | No |
|
|
|
|
#### ExternalHitTestingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| query | [ExternalHitTestingQueryResponse](#externalhittestingqueryresponse) | | Yes |
|
|
| records | [ [ExternalHitTestingRecordResponse](#externalhittestingrecordresponse) ] | | Yes |
|
|
|
|
#### ExternalKnowledgeApiBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### ExternalKnowledgeApiListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ExternalKnowledgeApiResponse](#externalknowledgeapiresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### ExternalKnowledgeApiPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| settings | object | | Yes |
|
|
|
|
#### ExternalKnowledgeApiResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | string | | Yes |
|
|
| created_by | string | | Yes |
|
|
| dataset_bindings | [ [ExternalKnowledgeApiBindingResponse](#externalknowledgeapibindingresponse) ] | | Yes |
|
|
| description | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| settings | [ExternalKnowledgeApiSettingsResponse](#externalknowledgeapisettingsresponse) | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### ExternalKnowledgeApiSettingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_key | string | | No |
|
|
| endpoint | string | | No |
|
|
|
|
#### ExternalRecipient
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| type | string, <br>**Default:** external | | No |
|
|
|
|
#### FeatureModel
|
|
|
|
Effective feature availability and limits for the current workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_quota_limit | [LimitationModel](#limitationmodel) | | Yes |
|
|
| api_rate_limit | [Quota](#quota) | | Yes |
|
|
| apps | [LimitationModel](#limitationmodel) | | Yes |
|
|
| billing | [BillingModel](#billingmodel) | | Yes |
|
|
| can_replace_logo | boolean | | Yes |
|
|
| documents_upload_quota | [LimitationModel](#limitationmodel) | | Yes |
|
|
| education | [EducationModel](#educationmodel) | | Yes |
|
|
| enable_knowledge_fs | boolean | | Yes |
|
|
| enable_skill | boolean, <br>**Default:** true | | Yes |
|
|
| human_input_email_delivery_enabled | boolean | | Yes |
|
|
| im_centrally_managed | boolean | | Yes |
|
|
| is_allow_transfer_workspace | boolean, <br>**Default:** true | | Yes |
|
|
| knowledge_pipeline | [KnowledgePipeline](#knowledgepipeline) | | Yes |
|
|
| members | [LimitationModel](#limitationmodel) | | Yes |
|
|
| model_load_balancing_enabled | boolean | | Yes |
|
|
| trigger_event | [Quota](#quota) | | Yes |
|
|
| webapp_copyright_enabled | boolean | | Yes |
|
|
| workspace_members | [LicenseLimitationModel](#licenselimitationmodel) | | Yes |
|
|
|
|
#### Feedback
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| from_account | [SimpleAccount](#simpleaccount) | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| rating | string | | Yes |
|
|
|
|
#### FeedbackStat
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dislike | integer | | Yes |
|
|
| like | integer | | Yes |
|
|
|
|
#### FeishuCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | Feishu or Lark application identifier. | Yes |
|
|
| app_secret | [_RequiredSecret](#_requiredsecret) | Feishu or Lark application secret. | Yes |
|
|
| encrypt_key | [_OptionalSecret](#_optionalsecret) | Optional callback encryption key. | No |
|
|
| provider | string | Feishu credential discriminator. | Yes |
|
|
| verification_token | [_OptionalSecret](#_optionalsecret) | Optional callback verification token. | No |
|
|
|
|
#### FeishuCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | [_Identifier](#_identifier)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| app_secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| encrypt_key | [_OptionalSecret](#_optionalsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
| verification_token | [_OptionalSecret](#_optionalsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
|
|
#### FeishuLarkCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| app_secret | [Redacted](#redacted) | | Yes |
|
|
| encrypt_key | [Redacted](#redacted) | | Yes |
|
|
| provider | string, <br>**Available values:** "feishu", "lark" | *Enum:* `"feishu"`, `"lark"` | Yes |
|
|
| verification_token | [Redacted](#redacted) | | Yes |
|
|
|
|
#### FetchFrom
|
|
|
|
Enum class for fetch from.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FetchFrom | string | Enum class for fetch from. | |
|
|
|
|
#### FieldModelSchema
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| placeholder | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
|
|
#### FileExtensionBlockedError
|
|
|
|
The file extension is blocked for security reasons.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FileExtensionBlockedError | | The file extension is blocked for security reasons. | |
|
|
|
|
#### FileInfo
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| extension | string | | Yes |
|
|
| filename | string | | Yes |
|
|
| mimetype | string | | Yes |
|
|
| size | integer | | Yes |
|
|
|
|
#### FileInput
|
|
|
|
Resolved single-file input constraints.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | Yes |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | Yes |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | Yes |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### FileInputConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | No |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### FileListInput
|
|
|
|
Resolved multi-file input constraints and effective number limit.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | Yes |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | Yes |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | Yes |
|
|
| number_limits | integer | | Yes |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### FileListInputConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ [FileType](#filetype) ] | | No |
|
|
| allowed_file_upload_methods | [ [FileTransferMethod](#filetransfermethod) ] | | No |
|
|
| number_limits | integer | | No |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### FileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| extension | string | | No |
|
|
| file_key | string | | No |
|
|
| id | string (uuid) | | Yes |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| original_url | string | | No |
|
|
| preview_url | string | | No |
|
|
| reference | string | | No |
|
|
| size | integer | | Yes |
|
|
| source_url | string | | No |
|
|
| tenant_id | string | | No |
|
|
| user_id | string | | No |
|
|
|
|
#### FileTooLargeError
|
|
|
|
File size exceeded. {message}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FileTooLargeError | | File size exceeded. {message} | |
|
|
|
|
#### FileTransferMethod
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FileTransferMethod | string | | |
|
|
|
|
#### FileType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FileType | string | | |
|
|
|
|
#### FileWithSignedUrl
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| extension | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| name | string | | Yes |
|
|
| size | integer | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### FilenameMissingError
|
|
|
|
filename is required
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FilenameMissingError | | filename is required | |
|
|
|
|
#### FilenameNotExistsError
|
|
|
|
The specified filename does not exist.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FilenameNotExistsError | | The specified filename does not exist. | |
|
|
|
|
#### ForbiddenError
|
|
|
|
You don't have the permission to access the requested resource.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ForbiddenError | | You don't have the permission to access the requested resource. | |
|
|
|
|
#### ForgotPasswordCheckPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| email | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### ForgotPasswordCheckResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | Email address | Yes |
|
|
| is_valid | boolean | Whether code is valid | Yes |
|
|
| token | string | New reset token | Yes |
|
|
|
|
#### ForgotPasswordEmailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | string | Reset token | No |
|
|
| result | string | Operation result | Yes |
|
|
|
|
#### ForgotPasswordResetPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_password | string | | Yes |
|
|
| password_confirm | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### ForgotPasswordResetResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Operation result | Yes |
|
|
|
|
#### ForgotPasswordSendPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| language | string | | No |
|
|
|
|
#### FormInputConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FormInputConfig | [ParagraphInputConfig](#paragraphinputconfig)<br>[SelectInputConfig](#selectinputconfig)<br>[FileInputConfig](#fileinputconfig)<br>[FileListInputConfig](#filelistinputconfig) | | |
|
|
|
|
#### FormOption
|
|
|
|
Model class for form option.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| show_on | [ [FormShowOnObject](#formshowonobject) ], <br>**Default:** | | No |
|
|
| value | string | | Yes |
|
|
|
|
#### FormPart
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FormPart | [MarkdownFragment](#markdownfragment)<br>[ParagraphInput](#paragraphinput)<br>[SelectInput](#selectinput)<br>[FileInput](#fileinput)<br>[FileListInput](#filelistinput) | | |
|
|
|
|
#### FormShowOnObject
|
|
|
|
Model class for form show on.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| value | string | | Yes |
|
|
| variable | string | | Yes |
|
|
|
|
#### FormType
|
|
|
|
Enum class for form type.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| FormType | string | Enum class for form type. | |
|
|
|
|
#### GenerateSummaryPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_list | [ string ] | | Yes |
|
|
|
|
#### GeneratedAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| GeneratedAppResponse | | | |
|
|
|
|
#### GeneratorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| GeneratorResponse | | | |
|
|
|
|
#### GetContactResponse
|
|
|
|
Response body for one contact resolved in the current workspace scope.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContact](#humaninputcontact) | Contact resolved as workspace, platform, or external. | Yes |
|
|
| im_binding_details | [ [ContactIMBindingDetail](#contactimbindingdetail) ] | Effective IM bindings and their identities in the current workspace, for the contact detail view. | Yes |
|
|
|
|
#### GetLatestIMSyncRunResponse
|
|
|
|
Response body for reading the latest IM sync run summary.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| run | [IMSyncRun](#imsyncrun) | Latest sync run summary. | Yes |
|
|
|
|
#### HitTestingChildChunk
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| id | string | | Yes |
|
|
| position | integer | | Yes |
|
|
| score | number | | Yes |
|
|
|
|
#### HitTestingDocument
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data_source_type | string | | Yes |
|
|
| doc_metadata | | | Yes |
|
|
| doc_type | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### HitTestingFile
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| extension | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| name | string | | Yes |
|
|
| size | integer | | Yes |
|
|
| source_url | string | | Yes |
|
|
|
|
#### HitTestingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| attachment_ids | [ string ] | List of attachment IDs to include in the retrieval context. | No |
|
|
| external_retrieval_model | object | Retrieval settings for external knowledge bases. | No |
|
|
| query | string | Search query text. | Yes |
|
|
| retrieval_model | [RetrievalModel](#retrievalmodel) | Retrieval model configuration. Controls how chunks are searched and ranked when querying this knowledge base. | No |
|
|
|
|
#### HitTestingQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
|
|
#### HitTestingRecord
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| child_chunks | [ [HitTestingChildChunk](#hittestingchildchunk) ] | | Yes |
|
|
| files | [ [HitTestingFile](#hittestingfile) ] | | Yes |
|
|
| score | number | | Yes |
|
|
| segment | [HitTestingSegment](#hittestingsegment) | Matched chunk from the knowledge base. | Yes |
|
|
| summary | string | | Yes |
|
|
| tsne_position | | | Yes |
|
|
|
|
#### HitTestingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| query | [HitTestingQuery](#hittestingquery) | The original query object. | Yes |
|
|
| records | [ [HitTestingRecord](#hittestingrecord) ] | | Yes |
|
|
|
|
#### HitTestingSegment
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | Yes |
|
|
| completed_at | integer | | Yes |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| disabled_at | integer | | Yes |
|
|
| disabled_by | string | | Yes |
|
|
| document | [HitTestingDocument](#hittestingdocument) | Parent document information for the matched chunk. | Yes |
|
|
| document_id | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| error | string | | Yes |
|
|
| hit_count | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| index_node_hash | string | | Yes |
|
|
| index_node_id | string | | Yes |
|
|
| indexing_at | integer | | Yes |
|
|
| keywords | [ string ] | | Yes |
|
|
| position | integer | | Yes |
|
|
| sign_content | string | | Yes |
|
|
| status | string | | Yes |
|
|
| stopped_at | integer | | Yes |
|
|
| tokens | integer | | Yes |
|
|
| word_count | integer | | Yes |
|
|
|
|
#### HumanInputContact
|
|
|
|
One contact entity returned by contact-related APIs.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | URL of the contact's avatar. | No |
|
|
| created_at | integer | Timestamp when the contact was created. | Yes |
|
|
| email | string | Primary contact email if one exists. | No |
|
|
| id | string | Unique contact identifier. | Yes |
|
|
| im_bindings | [ [IMBinding](#imbinding) ] | IM bindings that are bound to this contact. Currently, only one IM binding is supported. There is at most one IM binding per IM provider. | No |
|
|
| name | string | Display name shown in the contact directory. | Yes |
|
|
| type | [HumanInputContactType](#humaninputcontacttype) | Resolved contact type in the current workspace scope. | Yes |
|
|
|
|
#### HumanInputContactSummary
|
|
|
|
A trimmed version of `HumanInputContact` that only includes the fields needed for workflow orchestration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | URL of the contact's avatar. | No |
|
|
| created_at | integer | Timestamp when the contact was created. | Yes |
|
|
| id | string | Unique contact identifier. | Yes |
|
|
| name | string | Display name shown in the contact directory. | Yes |
|
|
|
|
#### HumanInputContactType
|
|
|
|
Concrete contact classification resolved in one workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| HumanInputContactType | string | Concrete contact classification resolved in one workspace. | |
|
|
|
|
#### HumanInputContent
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| form_definition | [HumanInputFormDefinition](#humaninputformdefinition) | | No |
|
|
| form_submission_data | [HumanInputFormSubmissionData](#humaninputformsubmissiondata) | | No |
|
|
| submitted | boolean | | Yes |
|
|
| type | [ExecutionContentType](#executioncontenttype) | | No |
|
|
| workflow_run_id | string | | Yes |
|
|
|
|
#### HumanInputDeliveryTestPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| delivery_method_id | string | Delivery method ID | Yes |
|
|
| inputs | object | Values used to fill missing upstream variables referenced in form_content | No |
|
|
|
|
#### HumanInputFormDefinition
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| actions | [ [UserActionConfig](#useractionconfig) ] | | No |
|
|
| display_in_ui | boolean | | No |
|
|
| expiration_time | integer | | Yes |
|
|
| form_content | string | | Yes |
|
|
| form_id | string | | Yes |
|
|
| form_token | string | | No |
|
|
| form_version | string, <br>**Available values:** "1", "2", <br>**Default:** 1 | *Enum:* `"1"`, `"2"` | No |
|
|
| inputs | [ [FormInputConfig](#forminputconfig) ] | | No |
|
|
| node_id | string | | Yes |
|
|
| node_title | string | | Yes |
|
|
| resolved_default_values | object | | No |
|
|
|
|
#### HumanInputFormExpiredError
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| HumanInputFormExpiredError | | | |
|
|
|
|
#### HumanInputFormPreviewPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | Values used to fill missing upstream variables referenced in form_content | No |
|
|
|
|
#### HumanInputFormPreviewResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| actions | [ [UserActionConfig](#useractionconfig) ] | | No |
|
|
| display_in_ui | boolean | | No |
|
|
| expiration_time | integer | | No |
|
|
| form_content | string | | Yes |
|
|
| form_id | string | | Yes |
|
|
| form_token | string | | No |
|
|
| inputs | [ [FormInputConfig](#forminputconfig) ] | | No |
|
|
| node_id | string | | Yes |
|
|
| node_title | string | | Yes |
|
|
| resolved_default_values | object | | No |
|
|
|
|
#### HumanInputFormPreviewSubmitPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string | Selected action ID | Yes |
|
|
| form_inputs | object | Values the user provides for the form's own fields | Yes |
|
|
| inputs | object | Values used to fill missing upstream variables referenced in form_content | Yes |
|
|
|
|
#### HumanInputFormSubmissionData
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action_id | string | | Yes |
|
|
| action_text | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| node_title | string | | Yes |
|
|
| rendered_content | string | | Yes |
|
|
| submitted_data | object | | No |
|
|
|
|
#### HumanInputFormSubmitPayload
|
|
|
|
Legacy Human Input v1 submit payload shared by existing runtime surfaces.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string | ID of the action button the recipient selected. Must match one of the `id` values from the form's `user_actions` list. | Yes |
|
|
| inputs | object | Submitted human input values keyed by output variable name. Use a string for paragraph or select input values, a file mapping for file inputs, and a list of file mappings for file-list inputs. Local file mappings use `transfer_method=local_file` with `upload_file_id`; remote file mappings use `transfer_method=remote_url` with `url` or `remote_url`. | Yes |
|
|
|
|
#### HumanInputFormSubmitResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| HumanInputFormSubmitResponse | object | | |
|
|
|
|
#### HumanInputFormSubmittedError
|
|
|
|
This form has already been submitted by another user, form_id={form_id}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| HumanInputFormSubmittedError | | This form has already been submitted by another user, form_id={form_id} | |
|
|
|
|
#### HumanInputNodeData
|
|
|
|
Human Input node data.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| debug_mode | [DebugModeConfig](#debugmodeconfig) | | Yes |
|
|
| default_value | [ [DefaultValue](#defaultvalue) ] | | No |
|
|
| desc | string | | No |
|
|
| error_strategy | [ErrorStrategy](#errorstrategy) | | No |
|
|
| form_content | string | | No |
|
|
| inputs | [ [FormInputConfig](#forminputconfig) ] | | No |
|
|
| message_template | [MessageTemplateConfig](#messagetemplateconfig) | | Yes |
|
|
| recipients_spec | [ [Contact](#contact)<br>[DynamicEmail](#dynamicemail)<br>[OnetimeEmail](#onetimeemail)<br>[Initiator](#initiator)<br>[AllWorkspaceContacts](#allworkspacecontacts) ] | | Yes |
|
|
| retry_config | [RetryConfig](#retryconfig) | | No |
|
|
| timeout | integer, <br>**Default:** 36 | | No |
|
|
| timeout_unit | [TimeoutUnit_Strict_strict_False_](#timeoutunit_strict_strict_false_) | | No |
|
|
| title | string | | No |
|
|
| type | string, <br>**Default:** human-input | | No |
|
|
| user_actions | [ [UserActionConfig](#useractionconfig) ] | | No |
|
|
| version | string, <br>**Default:** 2 | | No |
|
|
|
|
#### HumanInputPauseTypeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| backstage_input_url | string | | No |
|
|
| form_id | string | | Yes |
|
|
| form_version | string, <br>**Available values:** "1", "2", <br>**Default:** 1 | *Enum:* `"1"`, `"2"` | No |
|
|
| type | string | | Yes |
|
|
|
|
#### I18nObject
|
|
|
|
Model class for i18n object.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| en_US | string | | Yes |
|
|
| ja_JP | string | | No |
|
|
| pt_BR | string | | No |
|
|
| zh_Hans | string | | No |
|
|
|
|
#### IMBinding
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | Unique IM binding identifier. | Yes |
|
|
| provider | [IMProvider](#improvider) | Provider of the IM binding. | Yes |
|
|
| scope | [IMBindingScope](#imbindingscope) | Scope of the IM binding. | Yes |
|
|
|
|
#### IMBindingScope
|
|
|
|
Resolution scope of a contact-to-IM-identity binding.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMBindingScope | string | Resolution scope of a contact-to-IM-identity binding. | |
|
|
|
|
#### IMChannelCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [IMProviderCredentialsInput](#improvidercredentialsinput) | | Yes |
|
|
|
|
#### IMChannelDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [IMProviderCredentialsResponse](#improvidercredentialsresponse) | | Yes |
|
|
| summary | [ChannelSummary](#channelsummary) | | Yes |
|
|
|
|
#### IMChannelMutationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| summary | [ChannelSummary](#channelsummary) | | Yes |
|
|
|
|
#### IMChannelReplacementPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [IMProviderCredentialsInput](#improvidercredentialsinput) | | Yes |
|
|
| expected_config_version | [ConfigVersion](#configversion) | | Yes |
|
|
|
|
#### IMChannelTestPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [IMProviderCredentialsInput](#improvidercredentialsinput) | | Yes |
|
|
|
|
#### IMChannelUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [IMProviderCredentialsUpdateInput](#improvidercredentialsupdateinput) | | Yes |
|
|
| expected_config_version | [ConfigVersion](#configversion) | | Yes |
|
|
|
|
#### IMContactSyncErrorResponse
|
|
|
|
Stable expected application failure returned by IM sync and binding routes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | Machine-readable application error code. | Yes |
|
|
| message | string | Operator-safe error message. | Yes |
|
|
| status | integer | HTTP status code associated with this failure. | Yes |
|
|
|
|
#### IMDirectoryEntry
|
|
|
|
Normalized provider-side account observed during an IM sync run.
|
|
|
|
The entry is run-scoped input to identity and binding reconciliation. It does
|
|
not represent a stable Dify identity and must not be referenced by bindings
|
|
or runtime authorization. Sync results may retain a snapshot for display,
|
|
diagnostics, and audit; durable references use IMIdentity or IMBinding IDs.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| display_name | string | | No |
|
|
| email | string | | No |
|
|
| provider_user_id | string | | Yes |
|
|
|
|
#### IMIdentity
|
|
|
|
One synced IM identity that may be bound or overridden.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binding_status | [IMIdentityBindingStatus](#imidentitybindingstatus) | Whether this IM identity is currently bound to a contact. | Yes |
|
|
| display_name | string | Display name returned by the provider. | No |
|
|
| email | string | Email returned by the provider, if any. | No |
|
|
| id | string | Internal IM identity record identifier. | Yes |
|
|
| provider | [IMProvider](#improvider) | IM provider that owns this identity. | Yes |
|
|
| provider_user_id | string | Provider-side user identifier. | Yes |
|
|
|
|
#### IMIdentityBindingStatus
|
|
|
|
Whether a synchronized IM identity is currently bound.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMIdentityBindingStatus | string | Whether a synchronized IM identity is currently bound. | |
|
|
|
|
#### IMIdentitySnapshot
|
|
|
|
Last known persistent IM identity state retained by a sync result.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| display_name | string | | No |
|
|
| email | string | | No |
|
|
| identity_id | string | | Yes |
|
|
| provider_user_id | string | | Yes |
|
|
|
|
#### IMProvider
|
|
|
|
IM provider supported by Human Input contact and delivery flows.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMProvider | string | IM provider supported by Human Input contact and delivery flows. | |
|
|
|
|
#### IMProviderCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMProviderCredentialsInput | [FeishuCredentialsInput](#feishucredentialsinput)<br>[LarkCredentialsInput](#larkcredentialsinput)<br>[SlackCredentialsInput](#slackcredentialsinput)<br>[DingTalkCredentialsInput](#dingtalkcredentialsinput)<br>[MSTeamsCredentialsInput](#msteamscredentialsinput)<br>[WeComCredentialsInput](#wecomcredentialsinput) | | |
|
|
|
|
#### IMProviderCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMProviderCredentialsResponse | [FeishuLarkCredentialsResponse](#feishularkcredentialsresponse)<br>[SlackCredentialsResponse](#slackcredentialsresponse)<br>[DingTalkCredentialsResponse](#dingtalkcredentialsresponse)<br>[MSTeamsCredentialsResponse](#msteamscredentialsresponse)<br>[WeComCredentialsResponse](#wecomcredentialsresponse) | | |
|
|
|
|
#### IMProviderCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMProviderCredentialsUpdateInput | [FeishuCredentialsUpdateInput](#feishucredentialsupdateinput)<br>[LarkCredentialsUpdateInput](#larkcredentialsupdateinput)<br>[SlackCredentialsUpdateInput](#slackcredentialsupdateinput)<br>[DingTalkCredentialsUpdateInput](#dingtalkcredentialsupdateinput)<br>[MSTeamsCredentialsUpdateInput](#msteamscredentialsupdateinput)<br>[WeComCredentialsUpdateInput](#wecomcredentialsupdateinput) | | |
|
|
|
|
#### IMSyncRemovalReason
|
|
|
|
Stable reason for removing or replacing a current IM binding.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMSyncRemovalReason | string | Stable reason for removing or replacing a current IM binding. | |
|
|
|
|
#### IMSyncResultAdded
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContactSummary](#humaninputcontactsummary) | The contact that associated with this sync result. | Yes |
|
|
| entry | [IMDirectoryEntry](#imdirectoryentry) | Provider directory entry observed during the current sync run. | Yes |
|
|
| type | string, <br>**Default:** added | | No |
|
|
|
|
#### IMSyncResultFailed
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| entry | [IMDirectoryEntry](#imdirectoryentry) | Provider directory entry observed before this reconciliation failure, if available. | No |
|
|
| reason | string | Reason the binding failed to sync. | Yes |
|
|
| type | string, <br>**Default:** failed | | No |
|
|
|
|
#### IMSyncResultItem
|
|
|
|
One paginated reconciliation result entry for the latest sync run.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | Unique synchronization result identifier. | Yes |
|
|
| result | [IMSyncResultAdded](#imsyncresultadded)<br>[IMSyncResultRemoved](#imsyncresultremoved)<br>[IMSyncResultFailed](#imsyncresultfailed)<br>[IMSyncResultNotMatched](#imsyncresultnotmatched)<br>[IMSyncResultSkipped](#imsyncresultskipped) | Result bucket this entry belongs to. | Yes |
|
|
|
|
#### IMSyncResultNotMatched
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| entry | [IMDirectoryEntry](#imdirectoryentry) | Provider directory entry that could not be matched, if available. | No |
|
|
| type | string, <br>**Default:** not_matched | | No |
|
|
|
|
#### IMSyncResultRemoved
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContactSummary](#humaninputcontactsummary) | The contact that associated with this sync result. | Yes |
|
|
| last_known_identity | [IMIdentitySnapshot](#imidentitysnapshot) | Last known persistent IM identity state before its binding was removed. | Yes |
|
|
| reason | [IMSyncRemovalReason](#imsyncremovalreason) | Reason the existing IM binding was removed. | Yes |
|
|
| type | string, <br>**Default:** removed | | No |
|
|
|
|
#### IMSyncResultSkipped
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContactSummary](#humaninputcontactsummary) | The contact that associated with this sync result. | Yes |
|
|
| entry | [IMDirectoryEntry](#imdirectoryentry) | Provider directory entry observed before reconciliation was skipped, if available. | No |
|
|
| type | string, <br>**Default:** skipped | | No |
|
|
|
|
#### IMSyncResultType
|
|
|
|
Stable reconciliation bucket for one synchronized directory entry.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMSyncResultType | string | Stable reconciliation bucket for one synchronized directory entry. | |
|
|
|
|
#### IMSyncRun
|
|
|
|
One IM sync run snapshot.
|
|
|
|
The latest-only UI displays ``finished_at`` as the explicit sync time. The
|
|
transport contract intentionally does not expose a ``started_by`` actor.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channel_config_version | integer | Channel configuration revision captured when the sync run was created. | Yes |
|
|
| channel_id | string | Channel identifier captured when the sync run was created. | Yes |
|
|
| error_message | string | Terminal error message. Present only when the sync run status is `failed`. | No |
|
|
| finished_at | integer | Unix timestamp in seconds when the sync run finished. This is the sync time displayed by the latest-only UI and is None while the run is unfinished. | No |
|
|
| id | string | Unique sync run identifier. | Yes |
|
|
| provider | [IMProvider](#improvider) | IM provider associated with the sync run. | Yes |
|
|
| result_counts | [IMSyncRunResultCounts](#imsyncrunresultcounts) | Aggregate reconciliation counts for the current run snapshot. | Yes |
|
|
| started_at | integer | Unix timestamp in seconds when the sync run started. | No |
|
|
| status | [IMSyncRunStatus](#imsyncrunstatus) | Current lifecycle state of the sync run. | Yes |
|
|
|
|
#### IMSyncRunResultCounts
|
|
|
|
Aggregate result counts for one IM sync run.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| added | integer | Number of entries newly matched and bound. | Yes |
|
|
| failed | integer | Number of entries that failed to reconcile. | Yes |
|
|
| not_matched | integer | Number of entries that could not be matched. | Yes |
|
|
| removed | integer | Number of entries whose prior binding was removed. | Yes |
|
|
| skipped | integer | Number of entries intentionally skipped. | Yes |
|
|
|
|
#### IMSyncRunStatus
|
|
|
|
Lifecycle state of a manual IM directory synchronization.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IMSyncRunStatus | string | Lifecycle state of a manual IM directory synchronization. | |
|
|
|
|
#### IconInfo
|
|
|
|
Icon information model.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string, <br>**Available values:** "emoji", "image" | | No |
|
|
| icon_url | string | | No |
|
|
|
|
#### IconType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IconType | string | | |
|
|
|
|
#### IdentityMode
|
|
|
|
How Dify forwards the end-user's identity to an MCP server.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IdentityMode | string | How Dify forwards the end-user's identity to an MCP server. | |
|
|
|
|
#### Import
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | No |
|
|
| app_mode | [AppMode](#appmode) | | No |
|
|
| current_dsl_version | string, <br>**Default:** 0.7.0 | | No |
|
|
| error | string | | No |
|
|
| id | string | | Yes |
|
|
| imported_dsl_version | string | | No |
|
|
| permission_keys | [ string ] | | No |
|
|
| status | [ImportStatus](#importstatus) | | Yes |
|
|
| warnings | [ [DslImportWarning](#dslimportwarning) ] | | No |
|
|
|
|
#### ImportStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ImportStatus | string | | |
|
|
|
|
#### IncludeSecretQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| include_secret | string, <br>**Default:** false | Whether to include secret values in the exported DSL | No |
|
|
|
|
#### IndexTechniqueType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IndexTechniqueType | string | | |
|
|
|
|
#### IndexingEstimate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| preview | [ [PreviewDetail](#previewdetail) ] | | Yes |
|
|
| qa_preview | [ [QAPreviewDetail](#qapreviewdetail) ] | | No |
|
|
| total_segments | integer | | Yes |
|
|
|
|
#### IndexingEstimateError
|
|
|
|
Knowledge indexing estimate failed: {message}
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| IndexingEstimateError | | Knowledge indexing estimate failed: {message} | |
|
|
|
|
#### IndexingEstimatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset_id | string | | No |
|
|
| doc_form | string, <br>**Default:** text_model | | No |
|
|
| doc_language | string, <br>**Default:** English | | No |
|
|
| indexing_technique | string | | Yes |
|
|
| info_list | object | | Yes |
|
|
| process_rule | object | | Yes |
|
|
|
|
#### IndexingEstimateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| currency | string | | Yes |
|
|
| preview | [ [PreviewDetail](#previewdetail) ] | | Yes |
|
|
| qa_preview | [ [QAPreviewDetail](#qapreviewdetail) ] | | No |
|
|
| tokens | integer | | Yes |
|
|
| total_price | number<br>integer | | Yes |
|
|
| total_segments | integer | | Yes |
|
|
|
|
#### InfoList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data_source_type | string, <br>**Available values:** "notion_import", "upload_file", "website_crawl" | *Enum:* `"notion_import"`, `"upload_file"`, `"website_crawl"` | Yes |
|
|
| file_info_list | [KnowledgeFileInfo](#knowledgefileinfo) | | No |
|
|
| notion_info_list | [ [NotionInfo](#notioninfo) ] | | No |
|
|
| website_info_list | [WebsiteInfo](#websiteinfo) | | No |
|
|
|
|
#### Initiator
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Default:** initiator | | No |
|
|
|
|
#### Inner
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | No |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| provider | string | | No |
|
|
|
|
#### InputFieldDefinition
|
|
|
|
Input field definition for snippet parameters.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | string | | No |
|
|
| hint | boolean | | No |
|
|
| label | string | | No |
|
|
| max_length | integer | | No |
|
|
| options | [ string ] | | No |
|
|
| placeholder | string | | No |
|
|
| required | boolean | | No |
|
|
| type | string | | No |
|
|
|
|
#### InspectorUnavailableError
|
|
|
|
Sandbox inspector is unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InspectorUnavailableError | | Sandbox inspector is unavailable. | |
|
|
|
|
#### InstalledAppInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | Yes |
|
|
| icon_type | [IconType](#icontype) | | Yes |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| name | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
|
|
#### InstalledAppListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| has_more | boolean | | Yes |
|
|
| installed_apps | [ [InstalledAppResponse](#installedappresponse) ] | | Yes |
|
|
| next_cursor | string | | Yes |
|
|
|
|
#### InstalledAppNotFoundError
|
|
|
|
The app was not found in this workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InstalledAppNotFoundError | | The app was not found in this workspace. | |
|
|
|
|
#### InstalledAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app | [InstalledAppInfoResponse](#installedappinforesponse) | | Yes |
|
|
| app_owner_tenant_id | string | | Yes |
|
|
| editable | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| is_pinned | boolean | | Yes |
|
|
| last_used_at | integer | | Yes |
|
|
|
|
#### InstalledAppUnavailableError
|
|
|
|
The app is not available in this app library.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InstalledAppUnavailableError | | The app is not available in this app library. | |
|
|
|
|
#### InstalledAppUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| is_pinned | boolean | | No |
|
|
|
|
#### InstalledAppsListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | App ID to filter by | No |
|
|
| cursor | string | Opaque cursor returned by the previous page | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of installed apps to return | No |
|
|
| name | string | App name to search for | No |
|
|
|
|
#### InstantMessageChannelRecipient
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channel_id | string | | Yes |
|
|
| type | string, <br>**Default:** channel | | No |
|
|
|
|
#### InstantMessageDeliveryConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message | string | | No |
|
|
| provider | [InstantMessageProvider](#instantmessageprovider) | | Yes |
|
|
| recipients | [InstantMessageRecipients](#instantmessagerecipients) | | No |
|
|
|
|
#### InstantMessageDeliveryMethod
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | [InstantMessageDeliveryConfig](#instantmessagedeliveryconfig) | | Yes |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| id | string (uuid) | | No |
|
|
| type | string, <br>**Default:** im | | No |
|
|
|
|
#### InstantMessageProvider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InstantMessageProvider | string | | |
|
|
|
|
#### InstantMessageRecipients
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [InstantMessageChannelRecipient](#instantmessagechannelrecipient)<br>[InstantMessageUserRecipient](#instantmessageuserrecipient) ] | | No |
|
|
|
|
#### InstantMessageUserRecipient
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Default:** user | | No |
|
|
| user_id | string | | Yes |
|
|
|
|
#### InstructionGeneratePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current | string | Current instruction text | No |
|
|
| flow_id | string | Workflow/Flow ID | Yes |
|
|
| ideal_output | string | Expected ideal output | No |
|
|
| instruction | string | Instruction for generation | Yes |
|
|
| language | string, <br>**Default:** javascript | Programming language (javascript/python) | No |
|
|
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
|
|
| node_id | string | Node ID for workflow context | No |
|
|
|
|
#### InstructionTemplatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string | Instruction template type | Yes |
|
|
|
|
#### InteractiveSurfaceDeliveryMethod
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | [_InteractiveSurfaceDeliveryConfig](#_interactivesurfacedeliveryconfig) | | No |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| id | string (uuid) | | No |
|
|
| type | string, <br>**Default:** webapp | | No |
|
|
|
|
#### InvalidAccountDeletionCodeError
|
|
|
|
Invalid account deletion code.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidAccountDeletionCodeError | | Invalid account deletion code. | |
|
|
|
|
#### InvalidAccountPasswordError
|
|
|
|
The password does not satisfy the account password policy.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidAccountPasswordError | | The password does not satisfy the account password policy. | |
|
|
|
|
#### InvalidActionError
|
|
|
|
Invalid action.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidActionError | | Invalid action. | |
|
|
|
|
#### InvalidComposerConfigError
|
|
|
|
Invalid agent composer config.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidComposerConfigError | | Invalid agent composer config. | |
|
|
|
|
#### InvalidCursorError
|
|
|
|
The app list cursor is invalid. Refresh the list and try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidCursorError | | The app list cursor is invalid. Refresh the list and try again. | |
|
|
|
|
#### InvalidEmailError
|
|
|
|
The email address is not valid.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidEmailError | | The email address is not valid. | |
|
|
|
|
#### InvalidFormDataError
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidFormDataError | | | |
|
|
|
|
#### InvalidInputError
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidInputError | | | |
|
|
|
|
#### InvalidInvitationCodeError
|
|
|
|
Invalid invitation code.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidInvitationCodeError | | Invalid invitation code. | |
|
|
|
|
#### InvalidMetadataError
|
|
|
|
The metadata content is incorrect. Please check and verify.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidMetadataError | | The metadata content is incorrect. Please check and verify. | |
|
|
|
|
#### InvalidOrExpiredTokenError
|
|
|
|
The token is invalid or has expired.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidOrExpiredTokenError | | The token is invalid or has expired. | |
|
|
|
|
#### InvalidRequestError
|
|
|
|
Invalid skill request.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidRequestError | | Invalid skill request. | |
|
|
|
|
#### InvalidRoleError
|
|
|
|
Invalid role.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidRoleError | | Invalid role. | |
|
|
|
|
#### InvalidRosterAgentPackageError
|
|
|
|
The Roster Agent package is invalid.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidRosterAgentPackageError | | The Roster Agent package is invalid. | |
|
|
|
|
#### InvalidTracingConfigError
|
|
|
|
The tracing configuration is invalid.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvalidTracingConfigError | | The tracing configuration is invalid. | |
|
|
|
|
#### InvitationAccountMismatchError
|
|
|
|
This invitation was sent to another account. Please sign in with the invited account.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| InvitationAccountMismatchError | | This invitation was sent to another account. Please sign in with the invited account. | |
|
|
|
|
#### IterationNodeRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | | No |
|
|
|
|
#### JSONValueType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| JSONValueType | | | |
|
|
|
|
#### JsonObject
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| JsonObject | object | | |
|
|
|
|
#### JsonValue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| JsonValue | | | |
|
|
|
|
#### KnowledgeConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data_source | [DataSource](#datasource) | Document data source configuration. | No |
|
|
| doc_form | string, <br>**Available values:** "hierarchical_model", "qa_model", "text_model", <br>**Default:** text_model | `text_model` for standard text chunking, `hierarchical_model` for parent-child chunk structure, `qa_model` for question-answer pair extraction.<br>*Enum:* `"hierarchical_model"`, `"qa_model"`, `"text_model"` | No |
|
|
| doc_language | string, <br>**Default:** English | Language of the document for processing optimization. | No |
|
|
| duplicate | boolean, <br>**Default:** true | Whether duplicate document content is allowed. | No |
|
|
| embedding_model | string | Embedding model name. Use the `model` field from [Get Available Models](/api-reference/models/get-available-models) with `model_type=text-embedding`. | No |
|
|
| embedding_model_provider | string | Embedding model provider. Use the `provider` field from [Get Available Models](/api-reference/models/get-available-models) with `model_type=text-embedding`. | No |
|
|
| indexing_technique | string, <br>**Available values:** "economy", "high_quality" | `high_quality` uses embedding models for precise search; `economy` uses keyword-based indexing. Required when adding the first document to a knowledge base; subsequent documents inherit the knowledge base's indexing technique if omitted.<br>*Enum:* `"economy"`, `"high_quality"` | Yes |
|
|
| is_multimodal | boolean | Whether the document uses multimodal indexing. | No |
|
|
| name | string | Document name. | No |
|
|
| original_document_id | string | Original document ID for replacement updates. | No |
|
|
| process_rule | [ProcessRule](#processrule) | Processing rules for chunking. | No |
|
|
| retrieval_model | [RetrievalModel](#retrievalmodel) | Retrieval model configuration. Controls how chunks are searched and ranked in this knowledge base. | No |
|
|
| summary_index_setting | object | Summary index configuration. | No |
|
|
|
|
#### KnowledgeFSActiveProfileRevisions
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding | integer | | No |
|
|
| retrieval | integer | | No |
|
|
|
|
#### KnowledgeFSAdmittedQueryRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| activeDocumentIds | [ string ] | | No |
|
|
| activeEntityIds | [ string ] | | No |
|
|
| knowledgeSpaceId | string | | Yes |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | | No |
|
|
| query | string | | No |
|
|
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
|
|
| sessionId | string | | No |
|
|
|
|
#### KnowledgeFSAnswerTraceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | | Yes |
|
|
| evidence_bundle_id | string | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | *Enum:* `"auto"`, `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| query | string | | Yes |
|
|
| query_images | [ [KnowledgeFSQueryImageResponse](#knowledgefsqueryimageresponse) ] | | No |
|
|
| source | [KnowledgeFSTraceSource](#knowledgefstracesource) | | No |
|
|
| steps | [ [KnowledgeFSAnswerTraceStepResponse](#knowledgefsanswertracestepresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSAnswerTraceStepResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ended_at | string | | No |
|
|
| metadata | object | | Yes |
|
|
| name | string | | Yes |
|
|
| started_at | dateTime | | Yes |
|
|
| status | string, <br>**Available values:** "error", "ok", "skipped" | *Enum:* `"error"`, `"ok"`, `"skipped"` | Yes |
|
|
|
|
#### KnowledgeFSAppBindingListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSAppBindingResponse](#knowledgefsappbindingresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSAppBindingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| caller_kind | [KnowledgeFSAppSpaceJoinType](#knowledgefsappspacejointype) | | Yes |
|
|
|
|
#### KnowledgeFSAppBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| caller_kind | [KnowledgeFSAppSpaceJoinType](#knowledgefsappspacejointype) | | Yes |
|
|
| id | string | | Yes |
|
|
| revision | integer | | Yes |
|
|
| status | [KnowledgeFSAppSpaceJoinStatus](#knowledgefsappspacejoinstatus) | | Yes |
|
|
|
|
#### KnowledgeFSAppSpaceJoinStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSAppSpaceJoinStatus | string | | |
|
|
|
|
#### KnowledgeFSAppSpaceJoinType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSAppSpaceJoinType | string | | |
|
|
|
|
#### KnowledgeFSAsyncCrawlPreviewImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| kind | string | | Yes |
|
|
| pageIds | [ string ] | | Yes |
|
|
| previewWorkflowId | string | | Yes |
|
|
| syncPolicy | [KnowledgeFSDeferredSyncPolicyPayload](#knowledgefsdeferredsyncpolicypayload) | | Yes |
|
|
|
|
#### KnowledgeFSAsyncOnlineDocumentImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [KnowledgeFSOnlineDocumentWorkflowImportItemPayload](#knowledgefsonlinedocumentworkflowimportitempayload) ] | | Yes |
|
|
| kind | string | | Yes |
|
|
| syncPolicy | [KnowledgeFSDeferredSyncPolicyPayload](#knowledgefsdeferredsyncpolicypayload) | | Yes |
|
|
|
|
#### KnowledgeFSAsyncOnlineDriveImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [KnowledgeFSOnlineDriveWorkflowImportItemPayload](#knowledgefsonlinedriveworkflowimportitempayload) ] | | Yes |
|
|
| kind | string | | Yes |
|
|
| syncPolicy | [KnowledgeFSDeferredSyncPolicyPayload](#knowledgefsdeferredsyncpolicypayload) | | Yes |
|
|
|
|
#### KnowledgeFSAsyncSourceImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSAsyncSourceImportPayload | [KnowledgeFSAsyncCrawlPreviewImportPayload](#knowledgefsasynccrawlpreviewimportpayload)<br>[KnowledgeFSAsyncWebsiteCrawlImportPayload](#knowledgefsasyncwebsitecrawlimportpayload)<br>[KnowledgeFSAsyncOnlineDocumentImportPayload](#knowledgefsasynconlinedocumentimportpayload)<br>[KnowledgeFSAsyncOnlineDriveImportPayload](#knowledgefsasynconlinedriveimportpayload) | | |
|
|
|
|
#### KnowledgeFSAsyncWebsiteCrawlImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| kind | string | | Yes |
|
|
| sourceUrls | [ string ] | | Yes |
|
|
| syncPolicy | [KnowledgeFSDeferredSyncPolicyPayload](#knowledgefsdeferredsyncpolicypayload) | | Yes |
|
|
|
|
#### KnowledgeFSBackgroundTaskFailureResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string | | Yes |
|
|
| document_title | string | | No |
|
|
| error_code | string | | Yes |
|
|
| error_message | string | | Yes |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | Yes |
|
|
| job_id | string | | No |
|
|
|
|
#### KnowledgeFSBackgroundTaskListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
| task_ids | string | Comma-separated document or document_bulk task IDs for an exact lookup | No |
|
|
|
|
#### KnowledgeFSBackgroundTaskListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSBackgroundTaskResponse](#knowledgefsbackgroundtaskresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSBackgroundTaskResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| can_cancel | boolean | | Yes |
|
|
| can_retry | boolean | | Yes |
|
|
| completed_at | string | | No |
|
|
| created_at | dateTime | | Yes |
|
|
| document_id | string | | No |
|
|
| document_revision | integer | | No |
|
|
| document_title | string | | No |
|
|
| error_code | string | | No |
|
|
| error_message | string | | No |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| failures | [ [KnowledgeFSBackgroundTaskFailureResponse](#knowledgefsbackgroundtaskfailureresponse) ] | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| operation | string, <br>**Available values:** "document_delete", "document_processing", "document_reindex", "document_upload", "source_bulk", "source_crawl_import", "source_crawl_preview", "source_online_document_import", "source_online_drive_import", "source_sync" | *Enum:* `"document_delete"`, `"document_processing"`, `"document_reindex"`, `"document_upload"`, `"source_bulk"`, `"source_crawl_import"`, `"source_crawl_preview"`, `"source_online_document_import"`, `"source_online_drive_import"`, `"source_sync"` | Yes |
|
|
| progress_completed | integer | | Yes |
|
|
| progress_failed | integer | | Yes |
|
|
| progress_percent | integer | | Yes |
|
|
| progress_total | integer | | Yes |
|
|
| semantic_enrichment | [KnowledgeFSSemanticEnrichmentResponse](#knowledgefssemanticenrichmentresponse) | | No |
|
|
| source_id | string | | No |
|
|
| source_title | string | | No |
|
|
| state | string, <br>**Available values:** "canceled", "completed", "failed", "queued", "running" | *Enum:* `"canceled"`, `"completed"`, `"failed"`, `"queued"`, `"running"` | Yes |
|
|
| task_kind | string, <br>**Available values:** "document", "document_bulk", "source" | *Enum:* `"document"`, `"document_bulk"`, `"source"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSBadCaseCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reason | string | | Yes |
|
|
| tags | [ string ] | | No |
|
|
| trace_id | string | | Yes |
|
|
|
|
#### KnowledgeFSBadCaseListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSBadCaseResponse](#knowledgefsbadcaseresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSBadCaseResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | | Yes |
|
|
| id | string | | Yes |
|
|
| question | string | | No |
|
|
| reason | string | | Yes |
|
|
| replay_run_id | string | | No |
|
|
| revision | integer | | Yes |
|
|
| status | string, <br>**Available values:** "dismissed", "fixed", "open", "replaying" | *Enum:* `"dismissed"`, `"fixed"`, `"open"`, `"replaying"` | Yes |
|
|
| tags | [ string ] | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSBadCaseTraceReferenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| trace_id | string | | Yes |
|
|
|
|
#### KnowledgeFSBadCaseUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expected_revision | integer | | Yes |
|
|
| reason | string | | No |
|
|
| replay_run_id | string | | No |
|
|
| status | string, <br>**Available values:** "dismissed", "fixed", "open", "replaying" | *Enum:* `"dismissed"`, `"fixed"`, `"open"`, `"replaying"` | Yes |
|
|
| tags | [ string ] | | No |
|
|
|
|
#### KnowledgeFSBulkDeletionAcceptedItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string | | Yes |
|
|
| document_title | string | | No |
|
|
| job | [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse) | | Yes |
|
|
| status_url | string | | Yes |
|
|
|
|
#### KnowledgeFSBulkDeletionAcceptedResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| batch_id | string | | No |
|
|
| items | [ [KnowledgeFSBulkDeletionAcceptedItemResponse](#knowledgefsbulkdeletionaccepteditemresponse) ] | | Yes |
|
|
| results | [ [KnowledgeFSBulkDeletionResultResponse](#knowledgefsbulkdeletionresultresponse) ] | | No |
|
|
| status_url | string | | No |
|
|
| total | integer | | Yes |
|
|
|
|
#### KnowledgeFSBulkDeletionResultResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string | | Yes |
|
|
| error | [KnowledgeFSDurableDeletionErrorResponse](#knowledgefsdurabledeletionerrorresponse) | | No |
|
|
| job | [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse) | | No |
|
|
| status | string, <br>**Available values:** "accepted", "pending", "rejected" | *Enum:* `"accepted"`, `"pending"`, `"rejected"` | Yes |
|
|
| status_url | string | | No |
|
|
|
|
#### KnowledgeFSBulkDocumentAvailabilityFailureResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string | | Yes |
|
|
| status | string, <br>**Available values:** "conflict", "not_found" | *Enum:* `"conflict"`, `"not_found"` | Yes |
|
|
|
|
#### KnowledgeFSBulkDocumentAvailabilityItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documentId | string | | Yes |
|
|
| expectedRowVersion | integer | | Yes |
|
|
|
|
#### KnowledgeFSBulkDocumentAvailabilityPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documents | [ [KnowledgeFSBulkDocumentAvailabilityItem](#knowledgefsbulkdocumentavailabilityitem) ] | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
|
|
#### KnowledgeFSBulkDocumentAvailabilityResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse)<br>[KnowledgeFSBulkDocumentAvailabilityFailureResponse](#knowledgefsbulkdocumentavailabilityfailureresponse) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### KnowledgeFSBulkDocumentDeleteItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documentId | string | | Yes |
|
|
| expectedRevision | integer | | Yes |
|
|
|
|
#### KnowledgeFSBulkDocumentDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documents | [ [KnowledgeFSBulkDocumentDeleteItemPayload](#knowledgefsbulkdocumentdeleteitempayload) ] | | Yes |
|
|
|
|
#### KnowledgeFSBulkJobFailureResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string | | Yes |
|
|
| document_title | string | | No |
|
|
| error_code | string | | Yes |
|
|
| error_message | string | | Yes |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| job_id | string | | No |
|
|
|
|
#### KnowledgeFSBulkJobResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| canceled_items | integer | | Yes |
|
|
| completed_items | integer | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| failed_item_ids | [ string ] | | Yes |
|
|
| failed_items | integer | | Yes |
|
|
| failures | [ [KnowledgeFSBulkJobFailureResponse](#knowledgefsbulkjobfailureresponse) ] | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| status | string, <br>**Available values:** "canceled", "completed", "failed", "running" | *Enum:* `"canceled"`, `"completed"`, `"failed"`, `"running"` | Yes |
|
|
| total_items | integer | | Yes |
|
|
| type | string, <br>**Available values:** "document_delete", "document_reindex", "document_upload" | *Enum:* `"document_delete"`, `"document_reindex"`, `"document_upload"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSBulkLogicalDocumentDeleteItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documentId | string | | Yes |
|
|
| expectedRevision | integer | | Yes |
|
|
|
|
#### KnowledgeFSBulkLogicalDocumentDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documents | [ [KnowledgeFSBulkLogicalDocumentDeleteItemPayload](#knowledgefsbulklogicaldocumentdeleteitempayload) ] | | Yes |
|
|
|
|
#### KnowledgeFSControlSpacePermissionRole
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSControlSpacePermissionRole | string | | |
|
|
|
|
#### KnowledgeFSControlSpaceState
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSControlSpaceState | string | | |
|
|
|
|
#### KnowledgeFSControlSpaceVisibility
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSControlSpaceVisibility | string | | |
|
|
|
|
#### KnowledgeFSCrawlImportPagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| description | string | | No |
|
|
| sourceUrl | string | | Yes |
|
|
| title | string | | No |
|
|
|
|
#### KnowledgeFSCrawlImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| desiredSyncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
|
|
| pages | [ [KnowledgeFSCrawlImportPagePayload](#knowledgefscrawlimportpagepayload) ] | | No |
|
|
| replaceExistingSelection | boolean | | No |
|
|
| sourceUpdate | [KnowledgeFSSourceImportConfigurationPayload](#knowledgefssourceimportconfigurationpayload) | | No |
|
|
| sourceUrls | [ string ] | | Yes |
|
|
|
|
#### KnowledgeFSCrawlPreviewPageListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
|
|
#### KnowledgeFSCrawlPreviewPageListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSCrawlPreviewPageResponse](#knowledgefscrawlpreviewpageresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSCrawlPreviewPageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| etag | string | | No |
|
|
| page_id | string | | Yes |
|
|
| source_url | string | | Yes |
|
|
| title | string | | No |
|
|
|
|
#### KnowledgeFSCrawlPreviewSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| pageIds | [ string ] | | Yes |
|
|
|
|
#### KnowledgeFSCrawledPageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| description | string | | No |
|
|
| source_url | string | | Yes |
|
|
| title | string | | No |
|
|
|
|
#### KnowledgeFSCursorQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
|
|
#### KnowledgeFSDeferredSyncPolicyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| customIntervalSeconds | integer | | No |
|
|
| enabled | boolean | | Yes |
|
|
| mode | string, <br>**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
|
|
|
|
#### KnowledgeFSDocumentAvailabilityPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| expectedRowVersion | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentBatchDownloadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_ids | [ string ] | | Yes |
|
|
|
|
#### KnowledgeFSDocumentChunkListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
| query | string | | No |
|
|
|
|
#### KnowledgeFSDocumentChunkListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSDocumentChunkResponse](#knowledgefsdocumentchunkresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSDocumentChunkResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | | Yes |
|
|
| document_id | string | | Yes |
|
|
| document_revision | integer | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| end_offset | integer | | No |
|
|
| id | string | | Yes |
|
|
| kind | string, <br>**Available values:** "chunk", "image", "section", "summary", "table", <br>**Default:** chunk | *Enum:* `"chunk"`, `"image"`, `"section"`, `"summary"`, `"table"` | No |
|
|
| knowledge_space_id | string | | Yes |
|
|
| ordinal | integer | | Yes |
|
|
| parent_chunk_id | string | | No |
|
|
| parse_element_ids | [ string ] | | Yes |
|
|
| section_path | [ string ] | | No |
|
|
| start_offset | integer | | No |
|
|
| text | string | | Yes |
|
|
| token_count | integer | | Yes |
|
|
| user_metadata | object | | Yes |
|
|
|
|
#### KnowledgeFSDocumentCompilationJobResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| base_head_revision | integer | | No |
|
|
| candidate_fingerprint | string | | No |
|
|
| candidate_publication_id | string | | No |
|
|
| completed_at | number | | No |
|
|
| created_at | number | | Yes |
|
|
| document_asset_id | string | | Yes |
|
|
| error | string | | No |
|
|
| execution_attempts | integer | | No |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| max_execution_attempts | integer | | No |
|
|
| run_state | string | | No |
|
|
| stage | string, <br>**Available values:** "canceled", "failed", "nodes_generated", "outline_built", "parsed", "projection_built", "published", "queued", "smoke_eval_passed" | *Enum:* `"canceled"`, `"failed"`, `"nodes_generated"`, `"outline_built"`, `"parsed"`, `"projection_built"`, `"published"`, `"queued"`, `"smoke_eval_passed"` | Yes |
|
|
| updated_at | number | | Yes |
|
|
| version | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentCreateAcceptedResponse
|
|
|
|
Accepted staged or legacy multipart upload, preserving both response shapes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSDocumentCreateAcceptedResponse | [KnowledgeFSDocumentStagedUploadAcceptedResponse](#knowledgefsdocumentstageduploadacceptedresponse)<br>[KnowledgeFSDocumentUploadAcceptedResponse](#knowledgefsdocumentuploadacceptedresponse) | Accepted staged or legacy multipart upload, preserving both response shapes. | |
|
|
|
|
#### KnowledgeFSDocumentDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedRevision | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSDocumentMetadataPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedRowVersion | integer | | Yes |
|
|
| patch | object | | Yes |
|
|
|
|
#### KnowledgeFSDocumentMultimodalAssetQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| variant | string | | No |
|
|
|
|
#### KnowledgeFSDocumentMultimodalItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| asset_url | string | | No |
|
|
| caption | string | | No |
|
|
| end_offset | integer | | No |
|
|
| id | string | | Yes |
|
|
| modality | string, <br>**Available values:** "code", "image", "page", "table" | *Enum:* `"code"`, `"image"`, `"page"`, `"table"` | Yes |
|
|
| ocr_text | string | | No |
|
|
| page_number | integer | | No |
|
|
| parse_element_id | string | | Yes |
|
|
| section_path | [ string ] | | No |
|
|
| start_offset | integer | | No |
|
|
| text_preview | string | | No |
|
|
| thumbnail_url | string | | No |
|
|
| title | string | | No |
|
|
|
|
#### KnowledgeFSDocumentMultimodalManifestResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| artifact_hash | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| document_asset_id | string | | Yes |
|
|
| id | string | | Yes |
|
|
| items | [ [KnowledgeFSDocumentMultimodalItemResponse](#knowledgefsdocumentmultimodalitemresponse) ] | | Yes |
|
|
| manifest_version | string | | Yes |
|
|
| updated_at | string | | No |
|
|
| version | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentOutlineNodeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| child_node_ids | [ string ] | | No |
|
|
| children | [ [KnowledgeFSDocumentOutlineNodeResponse](#knowledgefsdocumentoutlinenoderesponse) ] | | No |
|
|
| end_offset | integer | | No |
|
|
| end_page | integer | | No |
|
|
| id | string | | Yes |
|
|
| level | integer | | Yes |
|
|
| metadata | object | | Yes |
|
|
| section_path | [ string ] | | No |
|
|
| source_element_ids | [ string ] | | No |
|
|
| source_node_ids | [ string ] | | No |
|
|
| start_offset | integer | | No |
|
|
| start_page | integer | | No |
|
|
| summary | string | | No |
|
|
| title | string | | Yes |
|
|
| title_location | object | | No |
|
|
| toc_source | string | | Yes |
|
|
|
|
#### KnowledgeFSDocumentOutlineResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| artifact_hash | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| document_asset_id | string | | Yes |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| metadata | object | | Yes |
|
|
| nodes | [ [KnowledgeFSDocumentOutlineNodeResponse](#knowledgefsdocumentoutlinenoderesponse) ] | | Yes |
|
|
| outline_version | string | | Yes |
|
|
| parse_artifact_id | string | | Yes |
|
|
| updated_at | string | | No |
|
|
| version | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentReferenceQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_asset_id | string | | Yes |
|
|
| document_asset_version | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentReindexItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| asset | [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse) | | No |
|
|
| code | string | | No |
|
|
| compilation_job | object | | No |
|
|
| document_id | string | | No |
|
|
| error | string | | No |
|
|
| status | string, <br>**Available values:** "disabled", "failed", "not_found", "pending", "queued" | *Enum:* `"disabled"`, `"failed"`, `"not_found"`, `"pending"`, `"queued"` | Yes |
|
|
| status_url | string | | No |
|
|
|
|
#### KnowledgeFSDocumentReindexPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| all | boolean | | No |
|
|
| documentIds | [ string ] | | No |
|
|
|
|
#### KnowledgeFSDocumentReindexResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bulk_job_id | string | | Yes |
|
|
| items | [ [KnowledgeFSDocumentReindexItemResponse](#knowledgefsdocumentreindexitemresponse) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | | Yes |
|
|
| filename | string | | Yes |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| metadata | object | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| object_key | string | | Yes |
|
|
| parser_status | string, <br>**Available values:** "failed", "parsed", "pending" | *Enum:* `"failed"`, `"parsed"`, `"pending"` | Yes |
|
|
| sha256 | string | | Yes |
|
|
| size_bytes | integer | | Yes |
|
|
| source_id | string | | No |
|
|
| updated_at | string | | No |
|
|
| version | integer | | Yes |
|
|
|
|
#### KnowledgeFSDocumentRevisionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSDocumentRevisionResponse](#knowledgefsdocumentrevisionresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSDocumentRevisionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| activated_at | string | | No |
|
|
| content_hash | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| document_asset_id | string | | Yes |
|
|
| document_asset_version | integer | | Yes |
|
|
| document_id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| revision | integer | | Yes |
|
|
| size_bytes | integer | | Yes |
|
|
| state | string, <br>**Available values:** "active", "candidate", "failed", "superseded" | *Enum:* `"active"`, `"candidate"`, `"failed"`, `"superseded"` | Yes |
|
|
|
|
#### KnowledgeFSDocumentStagedUploadAcceptedResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| compilation_job_id | string | | Yes |
|
|
| document_asset_id | string | | Yes |
|
|
| status | string | | No |
|
|
| upload_id | string | | Yes |
|
|
|
|
#### KnowledgeFSDocumentStagedUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| upload_id | string | | Yes |
|
|
|
|
#### KnowledgeFSDocumentUploadAcceptedResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| asset | [KnowledgeFSDocumentResponse](#knowledgefsdocumentresponse) | | Yes |
|
|
| asset_status_url | string | | No |
|
|
| compilation_job | [KnowledgeFSDocumentUploadCompilationJobResponse](#knowledgefsdocumentuploadcompilationjobresponse) | | Yes |
|
|
| document_revision | integer | | Yes |
|
|
| logical_document | [KnowledgeFSDocumentUploadLogicalDocumentResponse](#knowledgefsdocumentuploadlogicaldocumentresponse) | | Yes |
|
|
| logical_document_id | string | | Yes |
|
|
| status | string | | No |
|
|
| status_url | string | | Yes |
|
|
|
|
#### KnowledgeFSDocumentUploadCompilationJobResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| stage | string | | Yes |
|
|
|
|
#### KnowledgeFSDocumentUploadLogicalDocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| revision | integer | | Yes |
|
|
|
|
#### KnowledgeFSDurableDeletionAcceptedResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_title | string | | No |
|
|
| job | [KnowledgeFSDurableDeletionJobResponse](#knowledgefsdurabledeletionjobresponse) | | Yes |
|
|
| status_url | string | | Yes |
|
|
|
|
#### KnowledgeFSDurableDeletionErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| message | string | | Yes |
|
|
| retryable | boolean | | Yes |
|
|
|
|
#### KnowledgeFSDurableDeletionJobResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checkpoint | string, <br>**Available values:** "completed", "deleting_derived_data", "deleting_objects", "deleting_primary_data", "quiescing", "requested" | *Enum:* `"completed"`, `"deleting_derived_data"`, `"deleting_objects"`, `"deleting_primary_data"`, `"quiescing"`, `"requested"` | Yes |
|
|
| completed_at | string | | No |
|
|
| created_at | dateTime | | Yes |
|
|
| error | [KnowledgeFSDurableDeletionErrorResponse](#knowledgefsdurabledeletionerrorresponse) | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| mode | string, <br>**Available values:** "cascade", "keep" | | No |
|
|
| progress | [KnowledgeFSDurableDeletionProgressResponse](#knowledgefsdurabledeletionprogressresponse) | | No |
|
|
| retry_at | string | | No |
|
|
| run_state | string, <br>**Available values:** "canceled", "completed", "dispatch_pending", "failed", "queued", "retry_wait", "running" | *Enum:* `"canceled"`, `"completed"`, `"dispatch_pending"`, `"failed"`, `"queued"`, `"retry_wait"`, `"running"` | Yes |
|
|
| target_id | string | | Yes |
|
|
| target_type | string, <br>**Available values:** "document", "knowledge_space", "logical_document", "source" | *Enum:* `"document"`, `"knowledge_space"`, `"logical_document"`, `"source"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSDurableDeletionProgressResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed_items | integer | | Yes |
|
|
| current_item_kind | string | | No |
|
|
| total_items | integer | | No |
|
|
|
|
#### KnowledgeFSEmbeddingSettingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dimension | integer | | No |
|
|
| model | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| revision | integer | | No |
|
|
| vector_space_id | string | | No |
|
|
|
|
#### KnowledgeFSExternalAccessPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_enabled | boolean | | Yes |
|
|
| mcp_enabled | boolean | | No |
|
|
| service_api_enabled | boolean | | Yes |
|
|
| workflow_enabled | boolean | | Yes |
|
|
|
|
#### KnowledgeFSExternalAccessResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_enabled | boolean | | Yes |
|
|
| mcp_enabled | boolean | | Yes |
|
|
| revision | integer | | Yes |
|
|
| service_api_enabled | boolean | | Yes |
|
|
| workflow_enabled | boolean | | Yes |
|
|
|
|
#### KnowledgeFSFeaturesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_enabled | boolean | | Yes |
|
|
| upload_enabled | boolean | | Yes |
|
|
|
|
#### KnowledgeFSGoldenQuestionBulkImportItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expected_evidence_id | string | | No |
|
|
| question_id | string | | Yes |
|
|
| row_index | integer | | Yes |
|
|
| similarity | number | | No |
|
|
| status | string, <br>**Available values:** "active", "draft" | *Enum:* `"active"`, `"draft"` | Yes |
|
|
|
|
#### KnowledgeFSGoldenQuestionBulkImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| match_policy | string, <br>**Available values:** "all", "any", <br>**Default:** all | *Enum:* `"all"`, `"any"` | No |
|
|
| minimum_similarity | number, <br>**Default:** 0.7 | | No |
|
|
| rows | [ [KnowledgeFSGoldenQuestionBulkImportRowPayload](#knowledgefsgoldenquestionbulkimportrowpayload) ] | | Yes |
|
|
|
|
#### KnowledgeFSGoldenQuestionBulkImportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_count | integer | | Yes |
|
|
| draft_count | integer | | Yes |
|
|
| items | [ [KnowledgeFSGoldenQuestionBulkImportItemResponse](#knowledgefsgoldenquestionbulkimportitemresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSGoldenQuestionBulkImportRowPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| evidence | string | | Yes |
|
|
| question | string | | Yes |
|
|
| tags | [ string ] | | No |
|
|
|
|
#### KnowledgeFSGoldenQuestionEvidenceCandidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_asset_id | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| page_number | integer | | No |
|
|
| projection_id | string | | No |
|
|
| score | number | | No |
|
|
| section_path | [ string ] | | Yes |
|
|
| text | string | | Yes |
|
|
|
|
#### KnowledgeFSGoldenQuestionEvidenceMatchPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| evidence | string | | No |
|
|
| minimum_similarity | number, <br>**Default:** 0.7 | | No |
|
|
| node_ids | [ string ] | | No |
|
|
| top_k | integer, <br>**Default:** 5 | | No |
|
|
|
|
#### KnowledgeFSGoldenQuestionEvidenceMatchResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| candidates | [ [KnowledgeFSGoldenQuestionEvidenceCandidateResponse](#knowledgefsgoldenquestionevidencecandidateresponse) ] | | Yes |
|
|
| evidence | string | | Yes |
|
|
| matched | boolean | | Yes |
|
|
|
|
#### KnowledgeFSGoldenQuestionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSGoldenQuestionResponse](#knowledgefsgoldenquestionresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSGoldenQuestionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation | string | | No |
|
|
| evidence_text | string | | No |
|
|
| expected_evidence_ids | [ string ] | | No |
|
|
| match_policy | string, <br>**Available values:** "all", "any", <br>**Default:** all | *Enum:* `"all"`, `"any"` | No |
|
|
| question | string | | Yes |
|
|
| source_bad_case_id | string | | No |
|
|
| tags | [ string ] | | No |
|
|
|
|
#### KnowledgeFSGoldenQuestionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| evidence_text | string | | No |
|
|
| expected_evidence_ids | [ string ] | | No |
|
|
| id | string | | Yes |
|
|
| match_policy | string, <br>**Available values:** "all", "any", <br>**Default:** all | *Enum:* `"all"`, `"any"` | No |
|
|
| question | string | | Yes |
|
|
| status | string, <br>**Available values:** "active", "draft", "paused", "stale" | *Enum:* `"active"`, `"draft"`, `"paused"`, `"stale"` | Yes |
|
|
| status_reason | string, <br>**Available values:** "source-deleted", "source-disabled" | | No |
|
|
| tags | [ string ] | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSInitialOnlineDocumentSourcePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentialId | string | | Yes |
|
|
| custom_interval_seconds | integer | | No |
|
|
| datasource | string | | Yes |
|
|
| kind | string | | Yes |
|
|
| name | string | | Yes |
|
|
| parameters | object | | No |
|
|
| pluginId | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| providerDisplayName | string | | No |
|
|
| selection | [ [KnowledgeFSOnlineDocumentWorkflowImportItemPayload](#knowledgefsonlinedocumentworkflowimportitempayload) ] | | Yes |
|
|
| sync_policy | string, <br>**Available values:** "custom", "daily", "manual", <br>**Default:** daily | *Enum:* `"custom"`, `"daily"`, `"manual"` | No |
|
|
|
|
#### KnowledgeFSInitialOnlineDriveSourcePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentialId | string | | Yes |
|
|
| custom_interval_seconds | integer | | No |
|
|
| datasource | string | | Yes |
|
|
| kind | string | | Yes |
|
|
| name | string | | Yes |
|
|
| parameters | object | | No |
|
|
| pluginId | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| providerDisplayName | string | | No |
|
|
| selection | [ [KnowledgeFSOnlineDriveWorkflowImportItemPayload](#knowledgefsonlinedriveworkflowimportitempayload) ] | | Yes |
|
|
| sync_policy | string, <br>**Available values:** "custom", "daily", "manual", <br>**Default:** daily | *Enum:* `"custom"`, `"daily"`, `"manual"` | No |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewDocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_edited_time | string | | No |
|
|
| name | string | | Yes |
|
|
| page_id | string | | Yes |
|
|
| provider_item_id | string | | Yes |
|
|
| type | string | | Yes |
|
|
| workspace_id | string | | Yes |
|
|
| workspace_name | string | | No |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewFileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bucket | string | | No |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| provider_item_id | string | | Yes |
|
|
| size | integer | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewJobCreateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| job_id | string | | Yes |
|
|
| status | string, <br>**Default:** pending | | No |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewJobResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| job_id | string | | Yes |
|
|
| result | [KnowledgeFSInitialSourcePreviewResponse](#knowledgefsinitialsourcepreviewresponse) | | No |
|
|
| status | string, <br>**Available values:** "canceled", "completed", "failed", "pending", "running" | *Enum:* `"canceled"`, `"completed"`, `"failed"`, `"pending"`, `"running"` | Yes |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewPageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| page_id | string | | No |
|
|
| source_url | string | | Yes |
|
|
| title | string | | No |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentialId | string | | Yes |
|
|
| datasource | string | | Yes |
|
|
| kind | string, <br>**Available values:** "online_document", "online_drive" | *Enum:* `"online_document"`, `"online_drive"` | Yes |
|
|
| parameters | object | | No |
|
|
| pluginId | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| providerDisplayName | string | | No |
|
|
|
|
#### KnowledgeFSInitialSourcePreviewResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| configuration_fingerprint | string | | No |
|
|
| documents | [ [KnowledgeFSInitialSourcePreviewDocumentResponse](#knowledgefsinitialsourcepreviewdocumentresponse) ] | | No |
|
|
| files | [ [KnowledgeFSInitialSourcePreviewFileResponse](#knowledgefsinitialsourcepreviewfileresponse) ] | | No |
|
|
| kind | string, <br>**Available values:** "online_document", "online_drive", "website_crawl" | *Enum:* `"online_document"`, `"online_drive"`, `"website_crawl"` | Yes |
|
|
| next_page_parameters | object | | No |
|
|
| pages | [ [KnowledgeFSInitialSourcePreviewPageResponse](#knowledgefsinitialsourcepreviewpageresponse) ] | | No |
|
|
|
|
#### KnowledgeFSInitialWebsiteCrawlOptionsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| include_subpages | boolean, <br>**Default:** true | | No |
|
|
| limit | integer, <br>**Default:** 100 | | No |
|
|
|
|
#### KnowledgeFSInitialWebsiteSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| canonical_url | string | | No |
|
|
| pageId | string | | No |
|
|
| source_url | string | | Yes |
|
|
| title | string | | No |
|
|
|
|
#### KnowledgeFSInitialWebsiteSourcePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| crawl_options | [KnowledgeFSInitialWebsiteCrawlOptionsPayload](#knowledgefsinitialwebsitecrawloptionspayload) | | Yes |
|
|
| credentialId | string | | No |
|
|
| custom_interval_seconds | integer | | No |
|
|
| datasource | string, <br>**Default:** crawl | | No |
|
|
| kind | string | | Yes |
|
|
| name | string | | Yes |
|
|
| parameters | object | | No |
|
|
| pluginId | string | | No |
|
|
| previewConfigurationFingerprint | string | | No |
|
|
| previewJobId | string | | No |
|
|
| provider | string | | Yes |
|
|
| providerDisplayName | string | | No |
|
|
| root_url | string | | Yes |
|
|
| selection | [ [KnowledgeFSInitialWebsiteSelectionPayload](#knowledgefsinitialwebsiteselectionpayload) ] | | Yes |
|
|
| sync_policy | string, <br>**Available values:** "custom", "daily", "manual", <br>**Default:** daily | *Enum:* `"custom"`, `"daily"`, `"manual"` | No |
|
|
|
|
#### KnowledgeFSInitialWebsiteSourcePreviewPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentialId | string | | Yes |
|
|
| datasource | string | | Yes |
|
|
| kind | string | | Yes |
|
|
| parameters | object | | No |
|
|
| pluginId | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| providerDisplayName | string | | No |
|
|
|
|
#### KnowledgeFSJWKResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| alg | string | | Yes |
|
|
| e | string | | Yes |
|
|
| kid | string | | Yes |
|
|
| kty | string | | Yes |
|
|
| n | string | | Yes |
|
|
| use | string | | Yes |
|
|
|
|
#### KnowledgeFSJWKSResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keys | [ [KnowledgeFSJWKResponse](#knowledgefsjwkresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSLogicalDocumentDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedRevision | integer | | Yes |
|
|
|
|
#### KnowledgeFSLogicalDocumentListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSLogicalDocumentResponse](#knowledgefslogicaldocumentresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSLogicalDocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active | [KnowledgeFSDocumentRevisionResponse](#knowledgefsdocumentrevisionresponse) | | Yes |
|
|
| active_revision | integer | | No |
|
|
| created_at | dateTime | | Yes |
|
|
| disabled_at | string | | No |
|
|
| disabled_by_subject_id | string | | No |
|
|
| enabled | boolean, <br>**Default:** true | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| latest_task | [KnowledgeFSBackgroundTaskResponse](#knowledgefsbackgroundtaskresponse) | | No |
|
|
| provider_item_id | string | | No |
|
|
| row_version | integer | | Yes |
|
|
| source_id | string | | No |
|
|
| status | string, <br>**Available values:** "deleting", "failed", "pending", "ready" | *Enum:* `"deleting"`, `"failed"`, `"pending"`, `"ready"` | Yes |
|
|
| title | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| user_metadata | object | | Yes |
|
|
|
|
#### KnowledgeFSMemberBindingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | Yes |
|
|
| role | [KnowledgeFSControlSpacePermissionRole](#knowledgefscontrolspacepermissionrole) | | Yes |
|
|
|
|
#### KnowledgeFSMembersReplacePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| members | [ [KnowledgeFSMemberBindingPayload](#knowledgefsmemberbindingpayload) ] | | Yes |
|
|
|
|
#### KnowledgeFSMetadataFieldCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
|
|
#### KnowledgeFSMetadataFieldDeleteQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedRowVersion | integer | | Yes |
|
|
|
|
#### KnowledgeFSMetadataFieldDeleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deleted | boolean | | Yes |
|
|
|
|
#### KnowledgeFSMetadataFieldListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 100 | | No |
|
|
|
|
#### KnowledgeFSMetadataFieldListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSMetadataFieldResponse](#knowledgefsmetadatafieldresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSMetadataFieldResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| row_version | integer | | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | *Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSMetadataFieldUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedRowVersion | integer | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### KnowledgeFSModelIntent
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### KnowledgeFSOnlineDocumentWorkflowImportItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| etag | string | | No |
|
|
| lastEditedTime | string | | No |
|
|
| name | string | | No |
|
|
| pageId | string | | Yes |
|
|
| providerItemId | string | | Yes |
|
|
| type | string | | Yes |
|
|
| workspaceId | string | | Yes |
|
|
|
|
#### KnowledgeFSOnlineDocumentWorkflowImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| desiredSyncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
|
|
| items | [ [KnowledgeFSOnlineDocumentWorkflowImportItemPayload](#knowledgefsonlinedocumentworkflowimportitempayload) ] | | Yes |
|
|
| kind | string | | Yes |
|
|
| sourceUpdate | [KnowledgeFSSourceImportConfigurationPayload](#knowledgefssourceimportconfigurationpayload) | | No |
|
|
|
|
#### KnowledgeFSOnlineDriveWorkflowImportItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bucket | string | | No |
|
|
| etag | string | | No |
|
|
| id | string | | Yes |
|
|
| mimeType | string | | No |
|
|
| name | string | | Yes |
|
|
| providerItemId | string | | Yes |
|
|
|
|
#### KnowledgeFSOnlineDriveWorkflowImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| desiredSyncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
|
|
| items | [ [KnowledgeFSOnlineDriveWorkflowImportItemPayload](#knowledgefsonlinedriveworkflowimportitempayload) ] | | Yes |
|
|
| kind | string | | Yes |
|
|
| sourceUpdate | [KnowledgeFSSourceImportConfigurationPayload](#knowledgefssourceimportconfigurationpayload) | | No |
|
|
|
|
#### KnowledgeFSOverviewActivityActorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | No |
|
|
| type | string, <br>**Available values:** "member", "system" | *Enum:* `"member"`, `"system"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewActivityListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSOverviewActivityResponse](#knowledgefsoverviewactivityresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSOverviewActivityResourceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | No |
|
|
| type | string, <br>**Available values:** "document", "knowledge-space", "permission", "profile", "publication", "query", "source", "worker" | *Enum:* `"document"`, `"knowledge-space"`, `"permission"`, `"profile"`, `"publication"`, `"query"`, `"source"`, `"worker"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewActivityResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string, <br>**Available values:** "document.failed", "document.published", "permission.updated", "profile.published", "query.completed", "query.failed", "query.requested", "settings.updated", "source.failed", "source.synced", "worker.failed" | *Enum:* `"document.failed"`, `"document.published"`, `"permission.updated"`, `"profile.published"`, `"query.completed"`, `"query.failed"`, `"query.requested"`, `"settings.updated"`, `"source.failed"`, `"source.synced"`, `"worker.failed"` | Yes |
|
|
| actor | [KnowledgeFSOverviewActivityActorResponse](#knowledgefsoverviewactivityactorresponse) | | Yes |
|
|
| details | object | | Yes |
|
|
| id | string | | Yes |
|
|
| occurred_at | dateTime | | Yes |
|
|
| resource | [KnowledgeFSOverviewActivityResourceResponse](#knowledgefsoverviewactivityresourceresponse) | | Yes |
|
|
| result | string, <br>**Available values:** "canceled", "failure", "pending", "success" | *Enum:* `"canceled"`, `"failure"`, `"pending"`, `"success"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewAttentionActionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| kind | string, <br>**Available values:** "open-resource", "review-models", "review-permissions" | *Enum:* `"open-resource"`, `"review-models"`, `"review-permissions"` | Yes |
|
|
| resource_id | string | | No |
|
|
| resource_type | string, <br>**Available values:** "document", "failed-query", "knowledge-space", "source" | *Enum:* `"document"`, `"failed-query"`, `"knowledge-space"`, `"source"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewAttentionEvidenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| observed_at | dateTime | | Yes |
|
|
| value | number<br>string | | No |
|
|
|
|
#### KnowledgeFSOverviewAttentionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSOverviewAttentionResponse](#knowledgefsoverviewattentionresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSOverviewAttentionResourceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| type | string, <br>**Available values:** "document", "failed-query", "knowledge-space", "source" | *Enum:* `"document"`, `"failed-query"`, `"knowledge-space"`, `"source"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewAttentionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | [KnowledgeFSOverviewAttentionActionResponse](#knowledgefsoverviewattentionactionresponse) | | Yes |
|
|
| dismissed_until | string | | No |
|
|
| evidence | [ [KnowledgeFSOverviewAttentionEvidenceResponse](#knowledgefsoverviewattentionevidenceresponse) ] | | Yes |
|
|
| issue_key | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| resource | [KnowledgeFSOverviewAttentionResourceResponse](#knowledgefsoverviewattentionresourceresponse) | | Yes |
|
|
| revision | integer | | Yes |
|
|
| rule_id | string, <br>**Available values:** "failed-document", "low-quality-query", "model-readiness", "permission-readiness", "stale-source" | *Enum:* `"failed-document"`, `"low-quality-query"`, `"model-readiness"`, `"permission-readiness"`, `"stale-source"` | Yes |
|
|
| severity | string, <br>**Available values:** "critical", "info", "warning" | *Enum:* `"critical"`, `"info"`, `"warning"` | Yes |
|
|
| status | string, <br>**Available values:** "active", "dismissed", "resolved" | *Enum:* `"active"`, `"dismissed"`, `"resolved"` | Yes |
|
|
| title | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSOverviewCountComparisonResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| change_rate | number | | Yes |
|
|
| previous_value | integer | | Yes |
|
|
| value | integer | | Yes |
|
|
|
|
#### KnowledgeFSOverviewHealthComponentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| codes | [ string ] | | Yes |
|
|
| state | string, <br>**Available values:** "degraded", "healthy", "unavailable", "unknown" | *Enum:* `"degraded"`, `"healthy"`, `"unavailable"`, `"unknown"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewHealthComponentsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| index | [KnowledgeFSOverviewHealthComponentResponse](#knowledgefsoverviewhealthcomponentresponse) | | Yes |
|
|
| ingestion | [KnowledgeFSOverviewHealthComponentResponse](#knowledgefsoverviewhealthcomponentresponse) | | Yes |
|
|
| profile_publication | [KnowledgeFSOverviewHealthComponentResponse](#knowledgefsoverviewhealthcomponentresponse) | | Yes |
|
|
| query_availability | [KnowledgeFSOverviewHealthComponentResponse](#knowledgefsoverviewhealthcomponentresponse) | | Yes |
|
|
| source_freshness | [KnowledgeFSOverviewHealthComponentResponse](#knowledgefsoverviewhealthcomponentresponse) | | Yes |
|
|
| worker_readiness | [KnowledgeFSOverviewHealthComponentResponse](#knowledgefsoverviewhealthcomponentresponse) | | Yes |
|
|
|
|
#### KnowledgeFSOverviewHealthResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| components | [KnowledgeFSOverviewHealthComponentsResponse](#knowledgefsoverviewhealthcomponentsresponse) | | Yes |
|
|
| generated_at | dateTime | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| state | string, <br>**Available values:** "degraded", "healthy", "unavailable", "unknown" | *Enum:* `"degraded"`, `"healthy"`, `"unavailable"`, `"unknown"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewIndexCoverageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| indexed | integer | | Yes |
|
|
| percentage | number | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### KnowledgeFSOverviewInventoryDeltaResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| added_last_7d | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### KnowledgeFSOverviewInventoryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| generated_at | dateTime | | Yes |
|
|
| graph_entities | [KnowledgeFSOverviewInventoryDeltaResponse](#knowledgefsoverviewinventorydeltaresponse) | | Yes |
|
|
| graph_relations | [KnowledgeFSOverviewInventoryDeltaResponse](#knowledgefsoverviewinventorydeltaresponse) | | Yes |
|
|
| index_coverage | [KnowledgeFSOverviewIndexCoverageResponse](#knowledgefsoverviewindexcoverageresponse) | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| source_categories | [KnowledgeFSOverviewSourceCategoriesResponse](#knowledgefsoverviewsourcecategoriesresponse) | | Yes |
|
|
|
|
#### KnowledgeFSOverviewQueryOutcomeBucketResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answered | integer | | Yes |
|
|
| end_at | dateTime | | Yes |
|
|
| low_confidence | integer | | Yes |
|
|
| no_evidence | integer | | Yes |
|
|
| query_count | integer | | Yes |
|
|
| start_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSOverviewQueryOutcomeCountsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer_rate | number | | Yes |
|
|
| answered | integer | | Yes |
|
|
| low_confidence | integer | | Yes |
|
|
| no_evidence | integer | | Yes |
|
|
| query_count | integer | | Yes |
|
|
|
|
#### KnowledgeFSOverviewQueryOutcomesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| buckets | [ [KnowledgeFSOverviewQueryOutcomeBucketResponse](#knowledgefsoverviewqueryoutcomebucketresponse) ] | | Yes |
|
|
| current | [KnowledgeFSOverviewQueryOutcomeCountsResponse](#knowledgefsoverviewqueryoutcomecountsresponse) | | Yes |
|
|
| generated_at | dateTime | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| previous | [KnowledgeFSOverviewQueryOutcomeCountsResponse](#knowledgefsoverviewqueryoutcomecountsresponse) | | Yes |
|
|
| previous_since | dateTime | | Yes |
|
|
| since | dateTime | | Yes |
|
|
| window | string, <br>**Available values:** "24h", "30d", "7d" | *Enum:* `"24h"`, `"30d"`, `"7d"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewRateComparisonResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| change_percentage_points | number | | Yes |
|
|
| previous_value | number | | Yes |
|
|
| value | number | | Yes |
|
|
|
|
#### KnowledgeFSOverviewSourceCategoriesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| crawl | integer | | Yes |
|
|
| online_documents | integer | | Yes |
|
|
| online_drives | integer | | Yes |
|
|
| uploads | integer | | Yes |
|
|
|
|
#### KnowledgeFSOverviewStatsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer_rate | [KnowledgeFSOverviewRateComparisonResponse](#knowledgefsoverviewratecomparisonresponse) | | Yes |
|
|
| documents | integer | | Yes |
|
|
| fresh_source_count | integer | | Yes |
|
|
| freshness_seconds | integer | | No |
|
|
| generated_at | dateTime | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| latest_source_sync_at | string | | No |
|
|
| linked_apps | integer | | Yes |
|
|
| queries | [KnowledgeFSOverviewCountComparisonResponse](#knowledgefsoverviewcountcomparisonresponse) | | Yes |
|
|
| source_count | integer | | Yes |
|
|
| stale_source_count | integer | | Yes |
|
|
| window | string, <br>**Available values:** "24h", "30d", "7d" | *Enum:* `"24h"`, `"30d"`, `"7d"` | Yes |
|
|
|
|
#### KnowledgeFSOverviewWindowQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| window | string, <br>**Available values:** "24h", "30d", "7d", <br>**Default:** 24h | *Enum:* `"24h"`, `"30d"`, `"7d"` | No |
|
|
|
|
#### KnowledgeFSPermissionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSPermissionResponse](#knowledgefspermissionresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSPermissionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | Yes |
|
|
| revision | integer | | Yes |
|
|
| role | [KnowledgeFSControlSpacePermissionRole](#knowledgefscontrolspacepermissionrole) | | Yes |
|
|
| status | string | | Yes |
|
|
|
|
#### KnowledgeFSPresignedUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expires_at | integer | | Yes |
|
|
| headers | object | | Yes |
|
|
| method | string | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### KnowledgeFSProductPermission
|
|
|
|
Product-level capability of a caller on one Agent Knowledge Base.
|
|
|
|
These values are what the console returns as ``permission_keys`` so the web can gate
|
|
its UI. Enterprise RBAC is not evaluated in this vocabulary: Agent Knowledge Bases reuse
|
|
the Classic Knowledge Base (``dataset_*``) permission points, and each capability is
|
|
granted when the caller holds the dataset permission it maps to (see
|
|
:data:`RBAC_PERMISSION_BY_PRODUCT_PERMISSION`).
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSProductPermission | string | Product-level capability of a caller on one Agent Knowledge Base. These values are what the console returns as ``permission_keys`` so the web can gate its UI. Enterprise RBAC is not evaluated in this vocabulary: Agent Knowledge Bases reuse the Classic Knowledge Base (``dataset_*``) permission points, and each capability is granted when the caller holds the dataset permission it maps to (see :data:`RBAC_PERMISSION_BY_PRODUCT_PERMISSION`). | |
|
|
|
|
#### KnowledgeFSProductRerankProfile
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| model | [KnowledgeFSProfileModelSelection](#knowledgefsprofilemodelselection) | | No |
|
|
|
|
#### KnowledgeFSProductRetrievalProfile
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| defaultMode | string, <br>**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| reasoningModel | [KnowledgeFSProfileModelSelection](#knowledgefsprofilemodelselection) | | Yes |
|
|
| rerank | [KnowledgeFSProductRerankProfile](#knowledgefsproductrerankprofile) | | Yes |
|
|
| scoreThreshold | [KnowledgeFSProductScoreThreshold](#knowledgefsproductscorethreshold) | | Yes |
|
|
| topK | integer | | Yes |
|
|
|
|
#### KnowledgeFSProductScoreThreshold
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| stage | string, <br>**Available values:** "mode-final", "rerank", <br>**Default:** mode-final | *Enum:* `"mode-final"`, `"rerank"` | No |
|
|
| value | number | | No |
|
|
|
|
#### KnowledgeFSProfileMigrationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| candidate_publication_fingerprint | string | | No |
|
|
| changed_kind | string, <br>**Available values:** "embedding", "retrieval" | *Enum:* `"embedding"`, `"retrieval"` | Yes |
|
|
| checkpoint | string, <br>**Available values:** "activated", "candidate-built", "evaluated", "queued" | *Enum:* `"activated"`, `"candidate-built"`, `"evaluated"`, `"queued"` | Yes |
|
|
| completed_at | string | | No |
|
|
| created_at | dateTime | | Yes |
|
|
| error_code | string | | No |
|
|
| evaluation_summary | object | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| rebuild_scope | string, <br>**Available values:** "clone-publication", "full-page-index-summary-outline", "full-vector-space" | *Enum:* `"clone-publication"`, `"full-page-index-summary-outline"`, `"full-vector-space"` | Yes |
|
|
| run_state | string, <br>**Available values:** "canceled", "failed", "queued", "running", "succeeded" | *Enum:* `"canceled"`, `"failed"`, `"queued"`, `"running"`, `"succeeded"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSProfileModelSelection
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| pluginId | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### KnowledgeFSPublicFailureResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string, <br>**Available values:** "configure_model", "configure_parser", "configure_source", "contact_admin", "retry", "reupload" | | No |
|
|
| category | string, <br>**Available values:** "authorization", "canceled", "configuration", "conflict", "dependency", "internal", "not_found", "rate_limit", "timeout", "validation" | *Enum:* `"authorization"`, `"canceled"`, `"configuration"`, `"conflict"`, `"dependency"`, `"internal"`, `"not_found"`, `"rate_limit"`, `"timeout"`, `"validation"` | Yes |
|
|
| code | string, <br>**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | *Enum:* `"DOCUMENT_COMPILATION_FAILED"`, `"DOCUMENT_COMPILATION_LEASE_LOST"`, `"DOCUMENT_COMPILATION_PROFILE_CHANGED"`, `"DOCUMENT_COMPILATION_RETRYABLE"`, `"DOCUMENT_COUNT_QUOTA_EXCEEDED"`, `"DOCUMENT_COUNT_QUOTA_UNAVAILABLE"`, `"DOCUMENT_DISABLED"`, `"DOCUMENT_PARSER_INPUT_INVALID"`, `"DOCUMENT_PARSER_NOT_CONFIGURED"`, `"DOCUMENT_PARSER_RATE_LIMITED"`, `"DOCUMENT_PARSER_RESPONSE_INVALID"`, `"DOCUMENT_PARSER_TIMEOUT"`, `"DOCUMENT_PARSER_UNAVAILABLE"`, `"DOCUMENT_PARSER_UNSUPPORTED_TYPE"`, `"DOCUMENT_PDF_RENDER_FAILED"`, `"DURABLE_DELETION_IDEMPOTENCY_CONFLICT"`, `"EMBEDDING_DIMENSION_INVALID"`, `"EMBEDDING_DIMENSION_UNSUPPORTED"`, `"EXECUTION_ATTEMPTS_EXHAUSTED"`, `"KNOWLEDGE_FS_ACCESS_DENIED"`, `"KNOWLEDGE_FS_CONFLICT"`, `"KNOWLEDGE_FS_INTERNAL_ERROR"`, `"KNOWLEDGE_FS_INVALID_REQUEST"`, `"KNOWLEDGE_FS_NOT_FOUND"`, `"KNOWLEDGE_FS_RATE_LIMITED"`, `"KNOWLEDGE_FS_TIMEOUT"`, `"KNOWLEDGE_FS_UNAVAILABLE"`, `"KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND"`, `"KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS"`, `"KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT"`, `"LOGICAL_DOCUMENT_CAS_CONFLICT"`, `"MODEL_CAPABILITY_MISMATCH"`, `"MODEL_CONFIGURATION_STALE"`, `"MODEL_CREDENTIAL_INVALID"`, `"MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE"`, `"MODEL_IDENTITY_MISMATCH"`, `"MODEL_PREFLIGHT_CANCELED"`, `"MODEL_PREFLIGHT_FAILED"`, `"MODEL_PREFLIGHT_TIMEOUT"`, `"MODEL_PREFLIGHT_UNAVAILABLE"`, `"MODEL_PROFILE_ACTIVATION_INCOMPLETE"`, `"MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED"`, `"MODEL_RUNTIME_CONTEXT_LIMIT"`, `"MODEL_RUNTIME_FAILED"`, `"MODEL_RUNTIME_OUTPUT_LIMIT"`, `"MODEL_RUNTIME_RESPONSE_INVALID"`, `"MODEL_RUNTIME_TIMEOUT"`, `"MODEL_RUNTIME_UNAVAILABLE"`, `"MODEL_SELECTION_NOT_FOUND"`, `"RESEARCH_TASK_CAPABILITY_REVOKED"`, `"RESEARCH_TASK_DISPATCH_DEAD"`, `"RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED"`, `"RESEARCH_TASK_FAILED"`, `"RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID"`, `"RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID"`, `"RETRIEVAL_DELETION_IN_PROGRESS"`, `"RETRIEVAL_EXECUTION_LEASE_LOST"`, `"SOURCE_BULK_ACTION_FAILED"`, `"SOURCE_CONNECTION_UNAVAILABLE"`, `"SOURCE_CRAWL_PAGE_NOT_FOUND"`, `"SOURCE_CRAWL_PROVIDER_UNAVAILABLE"`, `"SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED"`, `"SOURCE_CREDENTIAL_CONFIG_INVALID"`, `"SOURCE_CREDENTIAL_MUTATION_FAILED"`, `"SOURCE_CREDENTIAL_TEST_FAILED"`, `"SOURCE_CREDENTIAL_UNAVAILABLE"`, `"SOURCE_DOCUMENT_COMPILATION_FAILED"`, `"SOURCE_DOCUMENT_MATERIALIZATION_FAILED"`, `"SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED"`, `"SOURCE_IMPORT_PARTIAL_FAILURE"`, `"SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID"`, `"SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_UNAVAILABLE"`, `"SOURCE_ONLINE_DRIVE_CONFIG_INVALID"`, `"SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED"`, `"SOURCE_ONLINE_DRIVE_IMPORT_FAILED"`, `"SOURCE_ONLINE_DRIVE_REQUEST_FAILED"`, `"SOURCE_ONLINE_DRIVE_UNAVAILABLE"`, `"SOURCE_OPERATION_FAILED"`, `"SOURCE_PROVIDER_REJECTED"`, `"SOURCE_PROVIDER_TIMEOUT"`, `"SOURCE_PROVIDER_UNAVAILABLE"`, `"SOURCE_SECRET_INTEGRITY_FAILED"`, `"SOURCE_SECRET_REF_CONFLICT"`, `"SOURCE_SYNC_FAILED"`, `"SOURCE_SYNC_SELECTION_MISMATCH"`, `"SOURCE_VERSION_CONFLICT"`, `"SOURCE_WEBSITE_CRAWL_CONFIG_INVALID"`, `"SOURCE_WEBSITE_CRAWL_FAILED"`, `"SOURCE_WORKFLOW_CONTENT_MISSING"`, `"SOURCE_WORKFLOW_CONTENT_TOO_LARGE"`, `"SOURCE_WORKFLOW_EXTERNAL_TIMEOUT"`, `"SOURCE_WORKFLOW_FAILED"`, `"UPLOAD_INITIALIZATION_FAILED"`, `"UPLOAD_INTEGRITY_MISMATCH"`, `"VECTOR_SPACE_QUOTA_EXCEEDED"`, `"VECTOR_SPACE_QUOTA_UNAVAILABLE"` | Yes |
|
|
| message | string | | Yes |
|
|
| parameters | object | | No |
|
|
| retryPolicy | string, <br>**Available values:** "after_configuration", "automatic", "manual", "never" | *Enum:* `"after_configuration"`, `"automatic"`, `"manual"`, `"never"` | Yes |
|
|
| stage | string | | No |
|
|
| traceId | string | | No |
|
|
|
|
#### KnowledgeFSQualityListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
|
|
#### KnowledgeFSQualityReplayDetailQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| evidence_item_id | string | | No |
|
|
|
|
#### KnowledgeFSQualityReplayEmbeddingProvenance
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dimension | integer | | Yes |
|
|
| model | string | | Yes |
|
|
| vector_space_id | string | | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayEvidenceDiff
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| evidence_items | [ [KnowledgeFSQualityReplayEvidenceItem](#knowledgefsqualityreplayevidenceitem) ] | | No |
|
|
| expected_count | integer | | Yes |
|
|
| matched_count | integer | | Yes |
|
|
| missing_count | integer | | Yes |
|
|
| retrieved_count | integer | | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayEvidenceItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available | boolean | | Yes |
|
|
| document_name | string | | No |
|
|
| matched | boolean | | Yes |
|
|
| ordinal | integer | | Yes |
|
|
| page_number | integer | | No |
|
|
| section_path | [ string ] | | No |
|
|
| text | string | | No |
|
|
|
|
#### KnowledgeFSQualityReplayItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| golden_question_id | string | | Yes |
|
|
| id | string | | Yes |
|
|
| match_policy | string, <br>**Available values:** "all", "any" | *Enum:* `"all"`, `"any"` | Yes |
|
|
| ordinal | integer | | Yes |
|
|
| question | string | | Yes |
|
|
| result | [KnowledgeFSQualityReplayItemResult](#knowledgefsqualityreplayitemresult) | | No |
|
|
| state | string, <br>**Available values:** "canceled", "failed", "passed", "queued", "running" | *Enum:* `"canceled"`, `"failed"`, `"passed"`, `"queued"`, `"running"` | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayItemResult
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| evidence_diff | [KnowledgeFSQualityReplayEvidenceDiff](#knowledgefsqualityreplayevidencediff) | | Yes |
|
|
| metrics | [KnowledgeFSQualityReplayMetrics](#knowledgefsqualityreplaymetrics) | | Yes |
|
|
| passed | boolean | | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| mode | string, <br>**Available values:** "deep", "fast", "research" | | No |
|
|
| state | string, <br>**Available values:** "canceled", "failed", "passed", "queued", "running" | | No |
|
|
|
|
#### KnowledgeFSQualityReplayListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSQualityReplayResponse](#knowledgefsqualityreplayresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSQualityReplayMetrics
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dense_candidates | integer | | No |
|
|
| fts_candidates | integer | | No |
|
|
| fused_candidates | integer | | No |
|
|
| graph_expansion_candidates | integer | | No |
|
|
| page_index_matched_nodes | integer | | No |
|
|
| permission_filtered_candidates | integer | | No |
|
|
| rerank_candidates | integer | | No |
|
|
| score_threshold_filtered_candidates | integer | | No |
|
|
| summary_candidates | integer | | No |
|
|
| total_ms | number | | No |
|
|
|
|
#### KnowledgeFSQualityReplayPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| golden_question_ids | [ string ] | | No |
|
|
| mode | string, <br>**Available values:** "deep", "fast", "research" | | No |
|
|
| selection | string | | No |
|
|
|
|
#### KnowledgeFSQualityReplayProjectionProvenance
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| projection_version | integer | | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayProvenance
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding | [KnowledgeFSQualityReplayEmbeddingProvenance](#knowledgefsqualityreplayembeddingprovenance) | | No |
|
|
| projection | [KnowledgeFSQualityReplayProjectionProvenance](#knowledgefsqualityreplayprojectionprovenance) | | Yes |
|
|
| retrieval | [KnowledgeFSQualityReplayRetrievalProvenance](#knowledgefsqualityreplayretrievalprovenance) | | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| attempt | integer | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| error | string | | No |
|
|
| id | string | | Yes |
|
|
| items | [ [KnowledgeFSQualityReplayItem](#knowledgefsqualityreplayitem) ] | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| mode | string, <br>**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| provenance | [KnowledgeFSQualityReplayProvenance](#knowledgefsqualityreplayprovenance) | | Yes |
|
|
| revision | integer | | Yes |
|
|
| state | string, <br>**Available values:** "canceled", "failed", "passed", "queued", "running" | *Enum:* `"canceled"`, `"failed"`, `"passed"`, `"queued"`, `"running"` | Yes |
|
|
| summary | [KnowledgeFSQualityReplaySummary](#knowledgefsqualityreplaysummary) | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSQualityReplayRetrievalProvenance
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| profile_revision | integer | | Yes |
|
|
| reasoning_model | string | | Yes |
|
|
| rerank_model | string | | No |
|
|
|
|
#### KnowledgeFSQualityReplaySummary
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed | integer | | Yes |
|
|
| failed | integer | | Yes |
|
|
| hit_rate | number | | Yes |
|
|
| passed | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### KnowledgeFSQueryAdmissionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expires_at | dateTime | | Yes |
|
|
| operation_id | string | | Yes |
|
|
| request | [KnowledgeFSAdmittedQueryRequest](#knowledgefsadmittedqueryrequest) | | Yes |
|
|
| token | string | | Yes |
|
|
| trace_id | string | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### KnowledgeFSQueryCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| activeDocumentIds | [ string ] | | No |
|
|
| activeEntityIds | [ string ] | | No |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | | No |
|
|
| query | string | | No |
|
|
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
|
|
| sessionId | string | | No |
|
|
|
|
#### KnowledgeFSQueryImageReference
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| uploadFileId | string | | Yes |
|
|
|
|
#### KnowledgeFSQueryImageResponse
|
|
|
|
One query image a retrieval run was asked with, enriched for console display.
|
|
|
|
The gateway persists only the UploadFile reference and static metadata; the console fills in
|
|
the file name and a short-lived signed preview URL for files the caller still owns.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| byte_size | integer | | No |
|
|
| mime_type | string | | No |
|
|
| name | string | | No |
|
|
| preview_url | string | | No |
|
|
| upload_file_id | string | | Yes |
|
|
|
|
#### KnowledgeFSQueryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | No |
|
|
| id | string | | Yes |
|
|
| status | string | | Yes |
|
|
| trace_id | string | | No |
|
|
|
|
#### KnowledgeFSQueryStreamCapabilityResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expires_at | dateTime | | Yes |
|
|
| operation_id | string | | Yes |
|
|
| token | string | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### KnowledgeFSReadinessCapabilities
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deep | boolean | | Yes |
|
|
| index | boolean | | Yes |
|
|
| ingest | boolean | | Yes |
|
|
| query | boolean | | Yes |
|
|
| research | boolean | | Yes |
|
|
| source_sync | boolean | | Yes |
|
|
|
|
#### KnowledgeFSReadinessIssue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string, <br>**Available values:** "binding_missing", "incompatible", "missing", "unavailable", "validation_failed" | *Enum:* `"binding_missing"`, `"incompatible"`, `"missing"`, `"unavailable"`, `"validation_failed"` | Yes |
|
|
| field | string, <br>**Available values:** "embedding", "publication", "reasoning", "rerank" | *Enum:* `"embedding"`, `"publication"`, `"reasoning"`, `"rerank"` | Yes |
|
|
| retryable | boolean | | Yes |
|
|
|
|
#### KnowledgeFSRerankIntent
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| model | [KnowledgeFSModelIntent](#knowledgefsmodelintent) | | No |
|
|
|
|
#### KnowledgeFSResearchTaskCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| budgetUsd | number | | No |
|
|
| limits | [KnowledgeFSResearchTaskLimits](#knowledgefsresearchtasklimits) | | No |
|
|
| metadata | object | | No |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | | No |
|
|
| query | string | | No |
|
|
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
|
|
| topK | integer | | No |
|
|
|
|
#### KnowledgeFSResearchTaskLimits
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| maxRetrievalSteps | integer | | No |
|
|
| maxScannedResources | integer | | No |
|
|
| maxToolCalls | integer | | No |
|
|
| timeoutMs | integer | | No |
|
|
|
|
#### KnowledgeFSResearchTaskListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSResearchTaskResponse](#knowledgefsresearchtaskresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSResearchTaskPartialListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSResearchTaskPartialResponse](#knowledgefsresearchtaskpartialresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSResearchTaskPartialResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | No |
|
|
| evidence_bundle | object | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| research_task_job_id | string | | Yes |
|
|
| sequence | integer | | Yes |
|
|
|
|
#### KnowledgeFSResearchTaskPartialsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 25 | | No |
|
|
|
|
#### KnowledgeFSResearchTaskPlanBudgetResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| budget_usd | number | | No |
|
|
| exceeds_budget | boolean | | Yes |
|
|
| remaining_budget_usd | number | | No |
|
|
|
|
#### KnowledgeFSResearchTaskPlanPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| budgetUsd | number | | No |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | | No |
|
|
| query | string | | No |
|
|
| queryImages | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
|
|
| topK | integer | | No |
|
|
|
|
#### KnowledgeFSResearchTaskPlanResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| budget | [KnowledgeFSResearchTaskPlanBudgetResponse](#knowledgefsresearchtaskplanbudgetresponse) | | Yes |
|
|
| estimates | object | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| query | string | | Yes |
|
|
| query_images | [ [KnowledgeFSQueryImageReference](#knowledgefsqueryimagereference) ] | | No |
|
|
| retrieval_plan | [KnowledgeFSResearchTaskRetrievalPlanResponse](#knowledgefsresearchtaskretrievalplanresponse) | | Yes |
|
|
| steps | [ object ] | | Yes |
|
|
| strategy_version | string | | Yes |
|
|
|
|
#### KnowledgeFSResearchTaskResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| budget_usd | number | | No |
|
|
| completed_at | number | | No |
|
|
| cost | object | | Yes |
|
|
| created_at | number | | Yes |
|
|
| error | string | | No |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| limits | [KnowledgeFSResearchTaskLimits](#knowledgefsresearchtasklimits) | | No |
|
|
| metadata | object | | Yes |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | | No |
|
|
| query | string | | Yes |
|
|
| query_images | [ [KnowledgeFSQueryImageResponse](#knowledgefsqueryimageresponse) ] | | No |
|
|
| stage | string, <br>**Available values:** "analyzing", "canceled", "completed", "failed", "generating", "paused", "planning", "queued", "retrieving" | *Enum:* `"analyzing"`, `"canceled"`, `"completed"`, `"failed"`, `"generating"`, `"paused"`, `"planning"`, `"queued"`, `"retrieving"` | Yes |
|
|
| top_k | integer | | No |
|
|
| updated_at | number | | Yes |
|
|
|
|
#### KnowledgeFSResearchTaskRetrievalPlanResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dense_top_k | integer | | Yes |
|
|
| fts_top_k | integer | | Yes |
|
|
| fusion_limit | integer | | Yes |
|
|
| query_language | string, <br>**Available values:** "cjk", "latin", "mixed-cjk-latin", "other" | *Enum:* `"cjk"`, `"latin"`, `"mixed-cjk-latin"`, `"other"` | Yes |
|
|
| requested_mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | *Enum:* `"auto"`, `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| rerank_candidate_limit | integer | | Yes |
|
|
| resolved_mode | string, <br>**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| strategy_version | string | | Yes |
|
|
| top_k | integer | | Yes |
|
|
|
|
#### KnowledgeFSResearchTaskStreamQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| knowledgeSpaceId | string | | Yes |
|
|
| limit | integer, <br>**Default:** 25 | | No |
|
|
|
|
#### KnowledgeFSResolvedDocumentReferenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_id | string | | Yes |
|
|
| revision | integer | | Yes |
|
|
|
|
#### KnowledgeFSRetrievalProfileIntent
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_mode | string, <br>**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| reasoning_model | [KnowledgeFSModelIntent](#knowledgefsmodelintent) | | Yes |
|
|
| rerank | [KnowledgeFSRerankIntent](#knowledgefsrerankintent) | | Yes |
|
|
| score_threshold | [KnowledgeFSScoreThresholdIntent](#knowledgefsscorethresholdintent) | | Yes |
|
|
| top_k | integer | | Yes |
|
|
|
|
#### KnowledgeFSRetrievalSettingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_mode | string, <br>**Available values:** "deep", "fast", "research" | *Enum:* `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| reasoning_model | [KnowledgeFSEmbeddingSettingsResponse](#knowledgefsembeddingsettingsresponse) | | Yes |
|
|
| rerank | [KnowledgeFSProductRerankProfile](#knowledgefsproductrerankprofile) | | Yes |
|
|
| revision | integer | | No |
|
|
| score_threshold | [KnowledgeFSProductScoreThreshold](#knowledgefsproductscorethreshold) | | Yes |
|
|
| top_k | integer | | Yes |
|
|
|
|
#### KnowledgeFSScoreThresholdIntent
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
| stage | string, <br>**Available values:** "mode-final", "rerank", <br>**Default:** mode-final | *Enum:* `"mode-final"`, `"rerank"` | No |
|
|
| value | number | | No |
|
|
|
|
#### KnowledgeFSSemanticEnrichmentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error_code | string | | No |
|
|
| error_message | string | | No |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| nodes_completed | integer | | Yes |
|
|
| nodes_total | integer | | No |
|
|
| provider_calls | integer | | No |
|
|
| provider_calls_maximum | integer | | No |
|
|
| state | string, <br>**Available values:** "disabled", "failed", "not_scheduled", "pending", "ready", "running" | *Enum:* `"disabled"`, `"failed"`, `"not_scheduled"`, `"pending"`, `"ready"`, `"running"` | Yes |
|
|
| updated_at | string | | No |
|
|
|
|
#### KnowledgeFSSettingsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding | [KnowledgeFSProfileModelSelection](#knowledgefsprofilemodelselection) | | No |
|
|
| expectedRevision | integer | | Yes |
|
|
| retrieval | [KnowledgeFSProductRetrievalProfile](#knowledgefsproductretrievalprofile) | | No |
|
|
|
|
#### KnowledgeFSSettingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_profile_available | boolean | | Yes |
|
|
| active_profile_revisions | [KnowledgeFSActiveProfileRevisions](#knowledgefsactiveprofilerevisions) | | Yes |
|
|
| capabilities | [KnowledgeFSReadinessCapabilities](#knowledgefsreadinesscapabilities) | | Yes |
|
|
| configuration_state | string, <br>**Available values:** "active", "pending-validation", "setup-required", "validation-failed" | *Enum:* `"active"`, `"pending-validation"`, `"setup-required"`, `"validation-failed"` | Yes |
|
|
| embedding | [KnowledgeFSEmbeddingSettingsResponse](#knowledgefsembeddingsettingsresponse) | | Yes |
|
|
| issues | [ [KnowledgeFSReadinessIssue](#knowledgefsreadinessissue) ] | | Yes |
|
|
| retrieval | [KnowledgeFSRetrievalSettingsResponse](#knowledgefsretrievalsettingsresponse) | | Yes |
|
|
| revision | integer | | Yes |
|
|
|
|
#### KnowledgeFSSettingsUpdateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| migration | [KnowledgeFSProfileMigrationResponse](#knowledgefsprofilemigrationresponse) | | No |
|
|
| settings | [KnowledgeFSSettingsResponse](#knowledgefssettingsresponse) | | Yes |
|
|
|
|
#### KnowledgeFSSmallFileUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| session | [KnowledgeFSUploadSessionResponse](#knowledgefsuploadsessionresponse) | | Yes |
|
|
|
|
#### KnowledgeFSSourceConnectionCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authKind | string, <br>**Available values:** "api-key", "endpoint" | *Enum:* `"api-key"`, `"endpoint"` | Yes |
|
|
| configuration | object | | No |
|
|
| credentials | object | | Yes |
|
|
| name | string | | Yes |
|
|
| providerId | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceConnectionListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
|
|
#### KnowledgeFSSourceConnectionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSSourceConnectionResponse](#knowledgefssourceconnectionresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSSourceConnectionRefreshPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedVersion | integer | | Yes |
|
|
|
|
#### KnowledgeFSSourceConnectionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auth_kind | string, <br>**Available values:** "api-key", "endpoint", "oauth2" | *Enum:* `"api-key"`, `"endpoint"`, `"oauth2"` | Yes |
|
|
| configuration | object | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| error_code | string | | No |
|
|
| expires_at | string | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| provider_id | string | | Yes |
|
|
| scopes | [ string ] | | Yes |
|
|
| status | string, <br>**Available values:** "active", "error", "expired", "provisioning", "revoked" | *Enum:* `"active"`, `"error"`, `"expired"`, `"provisioning"`, `"revoked"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| version | integer | | Yes |
|
|
|
|
#### KnowledgeFSSourceCrawlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed | integer | | No |
|
|
| failed | integer | | No |
|
|
| imported | integer | | No |
|
|
| pages | [ [KnowledgeFSCrawledPageResponse](#knowledgefscrawledpageresponse) ] | | Yes |
|
|
| replaced | integer | | No |
|
|
| skipped | integer | | No |
|
|
| status | string | | No |
|
|
| total | integer | | No |
|
|
|
|
#### KnowledgeFSSourceCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| connectionId | string | | No |
|
|
| credentials | object | | No |
|
|
| metadata | object | | No |
|
|
| name | string | | Yes |
|
|
| permissionScope | [ string ] | | No |
|
|
| status | string, <br>**Available values:** "active", "disabled", "error", "syncing" | | No |
|
|
| type | string, <br>**Available values:** "connector", "object-storage", "upload", "web" | *Enum:* `"connector"`, `"object-storage"`, `"upload"`, `"web"` | Yes |
|
|
| uri | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceCredentialTestResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string, <br>**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | | No |
|
|
| error | string | | No |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| valid | boolean | | Yes |
|
|
|
|
#### KnowledgeFSSourceDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedRevision | integer | | Yes |
|
|
|
|
#### KnowledgeFSSourceDeleteQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documents | string, <br>**Available values:** "cascade", "keep", <br>**Default:** cascade | *Enum:* `"cascade"`, `"keep"` | No |
|
|
|
|
#### KnowledgeFSSourceEditOnlineDocumentSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [KnowledgeFSOnlineDocumentWorkflowImportItemPayload](#knowledgefsonlinedocumentworkflowimportitempayload) ] | | Yes |
|
|
| kind | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceEditOnlineDriveSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [KnowledgeFSOnlineDriveWorkflowImportItemPayload](#knowledgefsonlinedriveworkflowimportitempayload) ] | | Yes |
|
|
| kind | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceEditSyncPolicyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| customIntervalSeconds | integer | | No |
|
|
| enabled | boolean | | Yes |
|
|
| mode | string, <br>**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
|
|
|
|
#### KnowledgeFSSourceEditWebsiteSelectionPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| kind | string | | Yes |
|
|
| sourceUrls | [ string ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceFileBucketResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bucket | string | | No |
|
|
| continuation_token | string | | No |
|
|
| files | [ [KnowledgeFSSourceFileResponse](#knowledgefssourcefileresponse) ] | | Yes |
|
|
| is_truncated | boolean | | No |
|
|
|
|
#### KnowledgeFSSourceFileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| size | number | | No |
|
|
| type | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceFilesQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bucket | string | | No |
|
|
| continuationToken | string | | No |
|
|
| maxKeys | integer | | No |
|
|
| prefix | string | | No |
|
|
|
|
#### KnowledgeFSSourceFilesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| buckets | [ [KnowledgeFSSourceFileBucketResponse](#knowledgefssourcefilebucketresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportConfigurationPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedVersion | integer | | Yes |
|
|
| metadata | object | | No |
|
|
| name | string | | No |
|
|
| providerParameters | object | | No |
|
|
| status | string, <br>**Available values:** "active", "disabled", "error", "syncing" | | No |
|
|
| uri | string | | No |
|
|
|
|
#### KnowledgeFSSourceImportFailureResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string, <br>**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | *Enum:* `"DOCUMENT_COMPILATION_FAILED"`, `"DOCUMENT_COMPILATION_LEASE_LOST"`, `"DOCUMENT_COMPILATION_PROFILE_CHANGED"`, `"DOCUMENT_COMPILATION_RETRYABLE"`, `"DOCUMENT_COUNT_QUOTA_EXCEEDED"`, `"DOCUMENT_COUNT_QUOTA_UNAVAILABLE"`, `"DOCUMENT_DISABLED"`, `"DOCUMENT_PARSER_INPUT_INVALID"`, `"DOCUMENT_PARSER_NOT_CONFIGURED"`, `"DOCUMENT_PARSER_RATE_LIMITED"`, `"DOCUMENT_PARSER_RESPONSE_INVALID"`, `"DOCUMENT_PARSER_TIMEOUT"`, `"DOCUMENT_PARSER_UNAVAILABLE"`, `"DOCUMENT_PARSER_UNSUPPORTED_TYPE"`, `"DOCUMENT_PDF_RENDER_FAILED"`, `"DURABLE_DELETION_IDEMPOTENCY_CONFLICT"`, `"EMBEDDING_DIMENSION_INVALID"`, `"EMBEDDING_DIMENSION_UNSUPPORTED"`, `"EXECUTION_ATTEMPTS_EXHAUSTED"`, `"KNOWLEDGE_FS_ACCESS_DENIED"`, `"KNOWLEDGE_FS_CONFLICT"`, `"KNOWLEDGE_FS_INTERNAL_ERROR"`, `"KNOWLEDGE_FS_INVALID_REQUEST"`, `"KNOWLEDGE_FS_NOT_FOUND"`, `"KNOWLEDGE_FS_RATE_LIMITED"`, `"KNOWLEDGE_FS_TIMEOUT"`, `"KNOWLEDGE_FS_UNAVAILABLE"`, `"KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND"`, `"KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS"`, `"KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED"`, `"KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT"`, `"LOGICAL_DOCUMENT_CAS_CONFLICT"`, `"MODEL_CAPABILITY_MISMATCH"`, `"MODEL_CONFIGURATION_STALE"`, `"MODEL_CREDENTIAL_INVALID"`, `"MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE"`, `"MODEL_IDENTITY_MISMATCH"`, `"MODEL_PREFLIGHT_CANCELED"`, `"MODEL_PREFLIGHT_FAILED"`, `"MODEL_PREFLIGHT_TIMEOUT"`, `"MODEL_PREFLIGHT_UNAVAILABLE"`, `"MODEL_PROFILE_ACTIVATION_INCOMPLETE"`, `"MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED"`, `"MODEL_RUNTIME_CONTEXT_LIMIT"`, `"MODEL_RUNTIME_FAILED"`, `"MODEL_RUNTIME_OUTPUT_LIMIT"`, `"MODEL_RUNTIME_RESPONSE_INVALID"`, `"MODEL_RUNTIME_TIMEOUT"`, `"MODEL_RUNTIME_UNAVAILABLE"`, `"MODEL_SELECTION_NOT_FOUND"`, `"RESEARCH_TASK_CAPABILITY_REVOKED"`, `"RESEARCH_TASK_DISPATCH_DEAD"`, `"RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED"`, `"RESEARCH_TASK_FAILED"`, `"RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID"`, `"RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID"`, `"RETRIEVAL_DELETION_IN_PROGRESS"`, `"RETRIEVAL_EXECUTION_LEASE_LOST"`, `"SOURCE_BULK_ACTION_FAILED"`, `"SOURCE_CONNECTION_UNAVAILABLE"`, `"SOURCE_CRAWL_PAGE_NOT_FOUND"`, `"SOURCE_CRAWL_PROVIDER_UNAVAILABLE"`, `"SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED"`, `"SOURCE_CREDENTIAL_CONFIG_INVALID"`, `"SOURCE_CREDENTIAL_MUTATION_FAILED"`, `"SOURCE_CREDENTIAL_TEST_FAILED"`, `"SOURCE_CREDENTIAL_UNAVAILABLE"`, `"SOURCE_DOCUMENT_COMPILATION_FAILED"`, `"SOURCE_DOCUMENT_MATERIALIZATION_FAILED"`, `"SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED"`, `"SOURCE_IMPORT_PARTIAL_FAILURE"`, `"SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID"`, `"SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED"`, `"SOURCE_ONLINE_DOCUMENT_UNAVAILABLE"`, `"SOURCE_ONLINE_DRIVE_CONFIG_INVALID"`, `"SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED"`, `"SOURCE_ONLINE_DRIVE_IMPORT_FAILED"`, `"SOURCE_ONLINE_DRIVE_REQUEST_FAILED"`, `"SOURCE_ONLINE_DRIVE_UNAVAILABLE"`, `"SOURCE_OPERATION_FAILED"`, `"SOURCE_PROVIDER_REJECTED"`, `"SOURCE_PROVIDER_TIMEOUT"`, `"SOURCE_PROVIDER_UNAVAILABLE"`, `"SOURCE_SECRET_INTEGRITY_FAILED"`, `"SOURCE_SECRET_REF_CONFLICT"`, `"SOURCE_SYNC_FAILED"`, `"SOURCE_SYNC_SELECTION_MISMATCH"`, `"SOURCE_VERSION_CONFLICT"`, `"SOURCE_WEBSITE_CRAWL_CONFIG_INVALID"`, `"SOURCE_WEBSITE_CRAWL_FAILED"`, `"SOURCE_WORKFLOW_CONTENT_MISSING"`, `"SOURCE_WORKFLOW_CONTENT_TOO_LARGE"`, `"SOURCE_WORKFLOW_EXTERNAL_TIMEOUT"`, `"SOURCE_WORKFLOW_FAILED"`, `"UPLOAD_INITIALIZATION_FAILED"`, `"UPLOAD_INTEGRITY_MISMATCH"`, `"VECTOR_SPACE_QUOTA_EXCEEDED"`, `"VECTOR_SPACE_QUOTA_UNAVAILABLE"` | Yes |
|
|
| error | string | | Yes |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| filename | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportFilePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bucket | string | | No |
|
|
| id | string | | Yes |
|
|
| mimeType | string | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportFilesPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ [KnowledgeFSSourceImportFilePayload](#knowledgefssourceimportfilepayload) ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportPagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| lastEditedTime | string | | No |
|
|
| name | string | | No |
|
|
| pageId | string | | Yes |
|
|
| type | string | | Yes |
|
|
| workspaceId | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportPagesPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| pages | [ [KnowledgeFSSourceImportPagePayload](#knowledgefssourceimportpagepayload) ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| documents | [ [KnowledgeFSSourceImportedDocumentResponse](#knowledgefssourceimporteddocumentresponse) ] | | Yes |
|
|
| failed | [ [KnowledgeFSSourceImportFailureResponse](#knowledgefssourceimportfailureresponse) ] | | Yes |
|
|
| skipped | [ string ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceImportedDocumentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| document_asset_id | string | | Yes |
|
|
| filename | string | | Yes |
|
|
|
|
#### KnowledgeFSSourceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSSourceResponse](#knowledgefssourceresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSSourcePageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_edited_time | string | | No |
|
|
| page_id | string | | Yes |
|
|
| page_name | string | | Yes |
|
|
| parent_id | string | | No |
|
|
| type | string | | Yes |
|
|
|
|
#### KnowledgeFSSourcePagesQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 50 | | No |
|
|
|
|
#### KnowledgeFSSourcePagesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| next_cursor | string | | No |
|
|
| workspaces | [ [KnowledgeFSSourceWorkspacePagesResponse](#knowledgefssourceworkspacepagesresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceProviderFieldResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| format | string, <br>**Available values:** "password", "uri" | | No |
|
|
| name | string | | Yes |
|
|
| required | boolean | | Yes |
|
|
| secret | boolean | | Yes |
|
|
| type | string, <br>**Available values:** "boolean", "integer", "string" | *Enum:* `"boolean"`, `"integer"`, `"string"` | Yes |
|
|
|
|
#### KnowledgeFSSourceProviderListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSSourceProviderResponse](#knowledgefssourceproviderresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSSourceProviderResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auth_kinds | [ string, <br>**Available values:** "api-key", "endpoint", "oauth2" ] | | Yes |
|
|
| available | boolean | | Yes |
|
|
| capabilities | [ string, <br>**Available values:** "online-document", "online-drive", "website-crawl" ] | | Yes |
|
|
| configuration | [ [KnowledgeFSSourceProviderFieldResponse](#knowledgefssourceproviderfieldresponse) ] | | Yes |
|
|
| display_name | string | | Yes |
|
|
| id | string | | Yes |
|
|
| unavailable_reason | string | | No |
|
|
|
|
#### KnowledgeFSSourceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| connection_id | string | | No |
|
|
| created_at | dateTime | | Yes |
|
|
| credential_configured | boolean | | No |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| last_synced_at | string | | No |
|
|
| metadata | object | | Yes |
|
|
| name | string | | Yes |
|
|
| permission_scope | [ string ] | | Yes |
|
|
| status | string, <br>**Available values:** "active", "disabled", "error", "syncing" | *Enum:* `"active"`, `"disabled"`, `"error"`, `"syncing"` | Yes |
|
|
| sync_policy | [KnowledgeFSSourceSyncPolicyResponse](#knowledgefssourcesyncpolicyresponse) | | No |
|
|
| sync_workflow | [KnowledgeFSSourceWorkflowResponse](#knowledgefssourceworkflowresponse) | | No |
|
|
| type | string, <br>**Available values:** "connector", "object-storage", "upload", "web" | *Enum:* `"connector"`, `"object-storage"`, `"upload"`, `"web"` | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| uri | string | | Yes |
|
|
| version | integer | | Yes |
|
|
|
|
#### KnowledgeFSSourceSyncPolicyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| customIntervalSeconds | integer | | No |
|
|
| enabled | boolean | | Yes |
|
|
| expectedRevision | integer | | Yes |
|
|
| expectedSourceVersion | integer | | Yes |
|
|
| mode | string, <br>**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
|
|
|
|
#### KnowledgeFSSourceSyncPolicyResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | | Yes |
|
|
| custom_interval_seconds | integer | | No |
|
|
| enabled | boolean | | Yes |
|
|
| expected_source_version | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| mode | string, <br>**Available values:** "custom", "interval", "manual" | *Enum:* `"custom"`, `"interval"`, `"manual"` | Yes |
|
|
| next_run_at | string | | No |
|
|
| revision | integer | | Yes |
|
|
| source_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSSourceUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expectedVersion | integer | | No |
|
|
| metadata | object | | No |
|
|
| name | string | | No |
|
|
| providerParameters | object | | No |
|
|
| selection | [KnowledgeFSSourceEditWebsiteSelectionPayload](#knowledgefssourceeditwebsiteselectionpayload)<br>[KnowledgeFSSourceEditOnlineDocumentSelectionPayload](#knowledgefssourceeditonlinedocumentselectionpayload)<br>[KnowledgeFSSourceEditOnlineDriveSelectionPayload](#knowledgefssourceeditonlinedriveselectionpayload) | | No |
|
|
| status | string, <br>**Available values:** "active", "disabled", "error", "syncing" | | No |
|
|
| syncAfterUpdate | boolean | | No |
|
|
| syncPolicy | [KnowledgeFSSourceEditSyncPolicyPayload](#knowledgefssourceeditsyncpolicypayload) | | No |
|
|
| uri | string | | No |
|
|
|
|
#### KnowledgeFSSourceWorkflowCancelPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reason | string | | No |
|
|
|
|
#### KnowledgeFSSourceWorkflowImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSSourceWorkflowImportPayload | [KnowledgeFSOnlineDocumentWorkflowImportPayload](#knowledgefsonlinedocumentworkflowimportpayload)<br>[KnowledgeFSOnlineDriveWorkflowImportPayload](#knowledgefsonlinedriveworkflowimportpayload) | | |
|
|
|
|
#### KnowledgeFSSourceWorkflowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| canceled_at | string | | No |
|
|
| checkpoint | string | | Yes |
|
|
| completed_at | string | | No |
|
|
| created_at | dateTime | | Yes |
|
|
| cursor | string | | No |
|
|
| execution_attempts | integer | | Yes |
|
|
| failure | [KnowledgeFSPublicFailureResponse](#knowledgefspublicfailureresponse) | | No |
|
|
| id | string | | Yes |
|
|
| kind | string | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| last_error_code | string, <br>**Available values:** "DOCUMENT_COMPILATION_FAILED", "DOCUMENT_COMPILATION_LEASE_LOST", "DOCUMENT_COMPILATION_PROFILE_CHANGED", "DOCUMENT_COMPILATION_RETRYABLE", "DOCUMENT_COUNT_QUOTA_EXCEEDED", "DOCUMENT_COUNT_QUOTA_UNAVAILABLE", "DOCUMENT_DISABLED", "DOCUMENT_PARSER_INPUT_INVALID", "DOCUMENT_PARSER_NOT_CONFIGURED", "DOCUMENT_PARSER_RATE_LIMITED", "DOCUMENT_PARSER_RESPONSE_INVALID", "DOCUMENT_PARSER_TIMEOUT", "DOCUMENT_PARSER_UNAVAILABLE", "DOCUMENT_PARSER_UNSUPPORTED_TYPE", "DOCUMENT_PDF_RENDER_FAILED", "DURABLE_DELETION_IDEMPOTENCY_CONFLICT", "EMBEDDING_DIMENSION_INVALID", "EMBEDDING_DIMENSION_UNSUPPORTED", "EXECUTION_ATTEMPTS_EXHAUSTED", "KNOWLEDGE_FS_ACCESS_DENIED", "KNOWLEDGE_FS_CONFLICT", "KNOWLEDGE_FS_INTERNAL_ERROR", "KNOWLEDGE_FS_INVALID_REQUEST", "KNOWLEDGE_FS_NOT_FOUND", "KNOWLEDGE_FS_RATE_LIMITED", "KNOWLEDGE_FS_TIMEOUT", "KNOWLEDGE_FS_UNAVAILABLE", "KNOWLEDGE_SPACE_MANIFEST_NOT_FOUND", "KNOWLEDGE_SPACE_MODEL_CONFIGURATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_COMPILATION_IN_PROGRESS", "KNOWLEDGE_SPACE_SETTINGS_MIGRATION_REQUIRED", "KNOWLEDGE_SPACE_SETTINGS_REVISION_CONFLICT", "LOGICAL_DOCUMENT_CAS_CONFLICT", "MODEL_CAPABILITY_MISMATCH", "MODEL_CONFIGURATION_STALE", "MODEL_CREDENTIAL_INVALID", "MODEL_CREDENTIAL_VALIDATION_UNAVAILABLE", "MODEL_IDENTITY_MISMATCH", "MODEL_PREFLIGHT_CANCELED", "MODEL_PREFLIGHT_FAILED", "MODEL_PREFLIGHT_TIMEOUT", "MODEL_PREFLIGHT_UNAVAILABLE", "MODEL_PROFILE_ACTIVATION_INCOMPLETE", "MODEL_PROFILE_ACTIVATION_PERMISSION_REQUIRED", "MODEL_RUNTIME_CONTEXT_LIMIT", "MODEL_RUNTIME_FAILED", "MODEL_RUNTIME_OUTPUT_LIMIT", "MODEL_RUNTIME_RESPONSE_INVALID", "MODEL_RUNTIME_TIMEOUT", "MODEL_RUNTIME_UNAVAILABLE", "MODEL_SELECTION_NOT_FOUND", "RESEARCH_TASK_CAPABILITY_REVOKED", "RESEARCH_TASK_DISPATCH_DEAD", "RESEARCH_TASK_EXECUTION_ATTEMPTS_EXHAUSTED", "RESEARCH_TASK_FAILED", "RESEARCH_TASK_PERMISSION_SNAPSHOT_INVALID", "RESEARCH_TASK_RUNTIME_SNAPSHOT_INVALID", "RETRIEVAL_DELETION_IN_PROGRESS", "RETRIEVAL_EXECUTION_LEASE_LOST", "SOURCE_BULK_ACTION_FAILED", "SOURCE_CONNECTION_UNAVAILABLE", "SOURCE_CRAWL_PAGE_NOT_FOUND", "SOURCE_CRAWL_PROVIDER_UNAVAILABLE", "SOURCE_CRAWL_RESULT_LIMIT_EXCEEDED", "SOURCE_CREDENTIAL_CONFIG_INVALID", "SOURCE_CREDENTIAL_MUTATION_FAILED", "SOURCE_CREDENTIAL_TEST_FAILED", "SOURCE_CREDENTIAL_UNAVAILABLE", "SOURCE_DOCUMENT_COMPILATION_FAILED", "SOURCE_DOCUMENT_MATERIALIZATION_FAILED", "SOURCE_DOCUMENT_REPLACEMENT_SAGA_REQUIRED", "SOURCE_IMPORT_PARTIAL_FAILURE", "SOURCE_ONLINE_DOCUMENT_CONFIG_INVALID", "SOURCE_ONLINE_DOCUMENT_IMPORT_FAILED", "SOURCE_ONLINE_DOCUMENT_PAGE_FETCH_FAILED", "SOURCE_ONLINE_DOCUMENT_REQUEST_FAILED", "SOURCE_ONLINE_DOCUMENT_UNAVAILABLE", "SOURCE_ONLINE_DRIVE_CONFIG_INVALID", "SOURCE_ONLINE_DRIVE_FILE_DOWNLOAD_FAILED", "SOURCE_ONLINE_DRIVE_IMPORT_FAILED", "SOURCE_ONLINE_DRIVE_REQUEST_FAILED", "SOURCE_ONLINE_DRIVE_UNAVAILABLE", "SOURCE_OPERATION_FAILED", "SOURCE_PROVIDER_REJECTED", "SOURCE_PROVIDER_TIMEOUT", "SOURCE_PROVIDER_UNAVAILABLE", "SOURCE_SECRET_INTEGRITY_FAILED", "SOURCE_SECRET_REF_CONFLICT", "SOURCE_SYNC_FAILED", "SOURCE_SYNC_SELECTION_MISMATCH", "SOURCE_VERSION_CONFLICT", "SOURCE_WEBSITE_CRAWL_CONFIG_INVALID", "SOURCE_WEBSITE_CRAWL_FAILED", "SOURCE_WORKFLOW_CONTENT_MISSING", "SOURCE_WORKFLOW_CONTENT_TOO_LARGE", "SOURCE_WORKFLOW_EXTERNAL_TIMEOUT", "SOURCE_WORKFLOW_FAILED", "UPLOAD_INITIALIZATION_FAILED", "UPLOAD_INTEGRITY_MISMATCH", "VECTOR_SPACE_QUOTA_EXCEEDED", "VECTOR_SPACE_QUOTA_UNAVAILABLE" | | No |
|
|
| max_execution_attempts | integer | | Yes |
|
|
| progress_completed | integer | | Yes |
|
|
| progress_failed | integer | | Yes |
|
|
| progress_skipped | integer | | Yes |
|
|
| progress_total | integer | | No |
|
|
| source_id | string | | No |
|
|
| state | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### KnowledgeFSSourceWorkspacePagesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| pages | [ [KnowledgeFSSourcePageResponse](#knowledgefssourcepageresponse) ] | | Yes |
|
|
| total | integer | | No |
|
|
| workspace_id | string | | No |
|
|
| workspace_name | string | | No |
|
|
|
|
#### KnowledgeFSSpaceCreateMemberPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | Yes |
|
|
| role | string | | Yes |
|
|
|
|
#### KnowledgeFSSpaceCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| embedding | [KnowledgeFSModelIntent](#knowledgefsmodelintent) | | No |
|
|
| icon | string | | No |
|
|
| idempotency_key | string | | No |
|
|
| initial_source | [KnowledgeFSInitialWebsiteSourcePayload](#knowledgefsinitialwebsitesourcepayload)<br>[KnowledgeFSInitialOnlineDocumentSourcePayload](#knowledgefsinitialonlinedocumentsourcepayload)<br>[KnowledgeFSInitialOnlineDriveSourcePayload](#knowledgefsinitialonlinedrivesourcepayload) | | No |
|
|
| members | [ [KnowledgeFSSpaceCreateMemberPayload](#knowledgefsspacecreatememberpayload) ] | | No |
|
|
| name | string | | Yes |
|
|
| retrieval | [KnowledgeFSRetrievalProfileIntent](#knowledgefsretrievalprofileintent) | | No |
|
|
| slug | string | | Yes |
|
|
| visibility | [KnowledgeFSControlSpaceVisibility](#knowledgefscontrolspacevisibility) | | No |
|
|
|
|
#### KnowledgeFSSpaceCreateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| control_space_id | string | | Yes |
|
|
| model_setup_required | boolean | | Yes |
|
|
| operation_id | string | | Yes |
|
|
| state | [KnowledgeFSControlSpaceState](#knowledgefscontrolspacestate) | | Yes |
|
|
|
|
#### KnowledgeFSSpaceDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| control_space_id | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| owner_account_id | string | | Yes |
|
|
| permission_keys | [ [KnowledgeFSProductPermission](#knowledgefsproductpermission) ] | | Yes |
|
|
| resource_version | integer | | Yes |
|
|
| state | [KnowledgeFSControlSpaceState](#knowledgefscontrolspacestate) | | Yes |
|
|
| technical_status | string, <br>**Available values:** "available", "not_ready", "unavailable" | *Enum:* `"available"`, `"not_ready"`, `"unavailable"` | Yes |
|
|
| technical_summary | [KnowledgeFSTechnicalSummary](#knowledgefstechnicalsummary) | | No |
|
|
| updated_at | dateTime | | Yes |
|
|
| visibility | [KnowledgeFSControlSpaceVisibility](#knowledgefscontrolspacevisibility) | | Yes |
|
|
|
|
#### KnowledgeFSSpaceListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| control_space_id | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| knowledge_space_id | string | | Yes |
|
|
| linked_apps | integer | | Yes |
|
|
| owner_account_id | string | | Yes |
|
|
| permission_keys | [ [KnowledgeFSProductPermission](#knowledgefsproductpermission) ] | | Yes |
|
|
| resource_version | integer | | Yes |
|
|
| state | [KnowledgeFSControlSpaceState](#knowledgefscontrolspacestate) | | Yes |
|
|
| tags | [ [KnowledgeFSSpaceTagResponse](#knowledgefsspacetagresponse) ] | | No |
|
|
| technical_status | string, <br>**Available values:** "available", "not_ready", "unavailable" | *Enum:* `"available"`, `"not_ready"`, `"unavailable"` | Yes |
|
|
| technical_summary | [KnowledgeFSTechnicalSummary](#knowledgefstechnicalsummary) | | No |
|
|
| updated_at | dateTime | | Yes |
|
|
| visibility | [KnowledgeFSControlSpaceVisibility](#knowledgefscontrolspacevisibility) | | Yes |
|
|
|
|
#### KnowledgeFSSpaceListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| creator_ids | [ string ] | Filter by creator account IDs | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
| query | string | | No |
|
|
| tag_ids | [ string ] | Filter by knowledge tag IDs using match-any semantics | No |
|
|
|
|
#### KnowledgeFSSpaceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSSpaceListItemResponse](#knowledgefsspacelistitemresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
|
|
#### KnowledgeFSSpaceTagListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSSpaceTagResponse](#knowledgefsspacetagresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSSpaceTagResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string, <br>**Default:** knowledge | | No |
|
|
|
|
#### KnowledgeFSSpaceTagsReplacePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tag_ids | [ string ] | | No |
|
|
|
|
#### KnowledgeFSSpaceUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| name | string | | No |
|
|
| visibility | [KnowledgeFSControlSpaceVisibility](#knowledgefscontrolspacevisibility) | | No |
|
|
|
|
#### KnowledgeFSStagedUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content_type | string | | Yes |
|
|
| expires_at | dateTime | | Yes |
|
|
| file_name | string | | Yes |
|
|
| id | string | | Yes |
|
|
| size_bytes | integer | | Yes |
|
|
| status | string, <br>**Available values:** "aborted", "claimed", "claiming", "expired", "failed", "uploaded" | *Enum:* `"aborted"`, `"claimed"`, `"claiming"`, `"expired"`, `"failed"`, `"uploaded"` | Yes |
|
|
|
|
#### KnowledgeFSStreamCapabilityPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| control_space_id | string | | Yes |
|
|
|
|
#### KnowledgeFSStreamCapabilityResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expires_at | dateTime | | Yes |
|
|
| operation_id | string | | Yes |
|
|
| token | string | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### KnowledgeFSTechnicalSummary
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| document_count | integer | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| index_state | string | | No |
|
|
| knowledge_space_id | string | | Yes |
|
|
| last_job_state | string | | No |
|
|
| model_profile | object | | No |
|
|
| name | string | | Yes |
|
|
| revision | integer | | Yes |
|
|
| slug | string | | Yes |
|
|
|
|
#### KnowledgeFSTraceEntriesQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| cursor | string | | No |
|
|
| limit | integer, <br>**Default:** 100 | | No |
|
|
|
|
#### KnowledgeFSTraceEntryListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| consistency_class | string | | No |
|
|
| data | [ [KnowledgeFSTraceEntryResponse](#knowledgefstraceentryresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
| path | string | | Yes |
|
|
| preview | boolean | | No |
|
|
| truncated | boolean | | Yes |
|
|
|
|
#### KnowledgeFSTraceEntryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| kind | string, <br>**Available values:** "directory", "resource" | *Enum:* `"directory"`, `"resource"` | Yes |
|
|
| metadata | object | | Yes |
|
|
| name | string | | Yes |
|
|
| path | string | | Yes |
|
|
| resource_type | string | | No |
|
|
| target_id | string | | No |
|
|
| version | integer | | No |
|
|
|
|
#### KnowledgeFSTraceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSTraceResponse](#knowledgefstraceresponse) ] | | Yes |
|
|
| next_cursor | string | | No |
|
|
|
|
#### KnowledgeFSTraceProfileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model | string | | No |
|
|
| embedding_vector_space_id | string | | No |
|
|
| projection_publication_id | string | | No |
|
|
| projection_version | integer | | No |
|
|
| reasoning_model | string | | No |
|
|
| rerank_model | string | | No |
|
|
| retrieval_profile_revision | integer | | No |
|
|
|
|
#### KnowledgeFSTraceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed | boolean | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| duration_ms | integer | | No |
|
|
| evidence_bundle_id | string | | No |
|
|
| evidence_state | string | | No |
|
|
| final_score | number | | No |
|
|
| id | string | | Yes |
|
|
| mode | string, <br>**Available values:** "auto", "deep", "fast", "research" | *Enum:* `"auto"`, `"deep"`, `"fast"`, `"research"` | Yes |
|
|
| open_bad_case_id | string | | No |
|
|
| profile | [KnowledgeFSTraceProfileResponse](#knowledgefstraceprofileresponse) | | Yes |
|
|
| query | string | | Yes |
|
|
| query_images | [ [KnowledgeFSQueryImageResponse](#knowledgefsqueryimageresponse) ] | | No |
|
|
| result_count | integer | | Yes |
|
|
| scores | [KnowledgeFSTraceScoresResponse](#knowledgefstracescoresresponse) | | Yes |
|
|
| source | [KnowledgeFSTraceSource](#knowledgefstracesource) | | No |
|
|
| stages | [ [KnowledgeFSTraceStageResponse](#knowledgefstracestageresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSTraceScoresResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| final | number | | No |
|
|
| rerank | number | | No |
|
|
| retrieval | number | | No |
|
|
|
|
#### KnowledgeFSTraceSource
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSTraceSource | string | | |
|
|
|
|
#### KnowledgeFSTraceStageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| candidate_count | integer | | No |
|
|
| name | string | | Yes |
|
|
| status | string, <br>**Available values:** "error", "ok", "skipped" | *Enum:* `"error"`, `"ok"`, `"skipped"` | Yes |
|
|
|
|
#### KnowledgeFSUpgradeBlockReason
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSUpgradeBlockReason | string | | |
|
|
|
|
#### KnowledgeFSUpgradeDiscoveryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| block_reason | [KnowledgeFSUpgradeBlockReason](#knowledgefsupgradeblockreason) | | No |
|
|
| can_retry | boolean | | Yes |
|
|
| can_upgrade | boolean | | Yes |
|
|
| job | [KnowledgeFSUpgradeJobResponse](#knowledgefsupgradejobresponse) | | No |
|
|
|
|
#### KnowledgeFSUpgradeJobListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [KnowledgeFSUpgradeJobResponse](#knowledgefsupgradejobresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSUpgradeJobResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed_at | string | | No |
|
|
| completed_documents | integer | | Yes |
|
|
| completed_sources | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| last_error_code | string | | No |
|
|
| last_error_message | string | | No |
|
|
| new_control_space_id | string | | No |
|
|
| old_dataset_id | string | | Yes |
|
|
| snapshot_at | dateTime | | Yes |
|
|
| stage | [KnowledgeFSUpgradeStage](#knowledgefsupgradestage) | | Yes |
|
|
| status | [KnowledgeFSUpgradeJobStatus](#knowledgefsupgradejobstatus) | | Yes |
|
|
| total_documents | integer | | Yes |
|
|
| total_sources | integer | | Yes |
|
|
|
|
#### KnowledgeFSUpgradeJobStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSUpgradeJobStatus | string | | |
|
|
|
|
#### KnowledgeFSUpgradeModelChoice
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### KnowledgeFSUpgradeModelErrorDetailsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| issues | [ [KnowledgeFSUpgradeModelIssueResponse](#knowledgefsupgrademodelissueresponse) ] | | Yes |
|
|
|
|
#### KnowledgeFSUpgradeModelIssueResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| field | string, <br>**Available values:** "embedding", "reasoning", "rerank" | *Enum:* `"embedding"`, `"reasoning"`, `"rerank"` | Yes |
|
|
| model | string | | No |
|
|
| provider | string | | No |
|
|
| reason | string, <br>**Available values:** "credential-removed", "deprecated", "disabled", "missing", "no-configure", "no-permission", "not_found", "quota-exceeded" | *Enum:* `"credential-removed"`, `"deprecated"`, `"disabled"`, `"missing"`, `"no-configure"`, `"no-permission"`, `"not_found"`, `"quota-exceeded"` | Yes |
|
|
|
|
#### KnowledgeFSUpgradeModelRecommendationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available | boolean | | Yes |
|
|
| source | string, <br>**Available values:** "legacy", "workspace_default" | | Yes |
|
|
| unavailable_reason | string, <br>**Available values:** "credential-removed", "deprecated", "disabled", "missing", "no-configure", "no-permission", "not_found", "quota-exceeded" | | No |
|
|
| value | [KnowledgeFSUpgradeModelChoice](#knowledgefsupgrademodelchoice) | | Yes |
|
|
|
|
#### KnowledgeFSUpgradeModelRecommendationsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding | [KnowledgeFSUpgradeModelRecommendationResponse](#knowledgefsupgrademodelrecommendationresponse) | | Yes |
|
|
| reasoning | [KnowledgeFSUpgradeModelRecommendationResponse](#knowledgefsupgrademodelrecommendationresponse) | | Yes |
|
|
| rerank | [KnowledgeFSUpgradeModelRecommendationResponse](#knowledgefsupgrademodelrecommendationresponse) | | Yes |
|
|
|
|
#### KnowledgeFSUpgradeModelsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding | [KnowledgeFSUpgradeModelChoice](#knowledgefsupgrademodelchoice) | | Yes |
|
|
| reasoning | [KnowledgeFSUpgradeModelChoice](#knowledgefsupgrademodelchoice) | | Yes |
|
|
| rerank | [KnowledgeFSUpgradeModelChoice](#knowledgefsupgrademodelchoice) | | Yes |
|
|
|
|
#### KnowledgeFSUpgradePreparationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| block_reason | [KnowledgeFSUpgradeBlockReason](#knowledgefsupgradeblockreason) | | No |
|
|
| can_retry | boolean | | Yes |
|
|
| can_upgrade | boolean | | Yes |
|
|
| job | [KnowledgeFSUpgradeJobResponse](#knowledgefsupgradejobresponse) | | No |
|
|
| models | [KnowledgeFSUpgradeModelRecommendationsResponse](#knowledgefsupgrademodelrecommendationsresponse) | | No |
|
|
|
|
#### KnowledgeFSUpgradeRetryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| status | string, <br>**Default:** queued | | No |
|
|
|
|
#### KnowledgeFSUpgradeStage
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFSUpgradeStage | string | | |
|
|
|
|
#### KnowledgeFSUpgradeStartPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| models | [KnowledgeFSUpgradeModelsPayload](#knowledgefsupgrademodelspayload) | | No |
|
|
|
|
#### KnowledgeFSUploadPartPresignPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checksumSha256Base64 | string | | Yes |
|
|
| contentLength | integer | | Yes |
|
|
|
|
#### KnowledgeFSUploadSessionAbortPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
|
|
#### KnowledgeFSUploadSessionCompletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| parts | [ [KnowledgeFSUploadSessionPartPayload](#knowledgefsuploadsessionpartpayload) ] | | No |
|
|
|
|
#### KnowledgeFSUploadSessionCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checksumSha256Base64 | string | | Yes |
|
|
| contentType | string | | Yes |
|
|
| expectedSizeBytes | integer | | Yes |
|
|
| fileName | string | | Yes |
|
|
|
|
#### KnowledgeFSUploadSessionCreateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| session | [KnowledgeFSUploadSessionResponse](#knowledgefsuploadsessionresponse) | | Yes |
|
|
| upload | [KnowledgeFSPresignedUploadResponse](#knowledgefspresigneduploadresponse) | | No |
|
|
|
|
#### KnowledgeFSUploadSessionMutationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| session | [KnowledgeFSUploadSessionResponse](#knowledgefsuploadsessionresponse) | | Yes |
|
|
|
|
#### KnowledgeFSUploadSessionPartPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checksumSha256Base64 | string | | No |
|
|
| etag | string | | Yes |
|
|
| partNumber | integer | | Yes |
|
|
|
|
#### KnowledgeFSUploadSessionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| compilation_job_id | string | | No |
|
|
| completed_at | integer | | No |
|
|
| document_asset_id | string | | No |
|
|
| expected_size_bytes | integer | | Yes |
|
|
| expires_at | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| mode | string, <br>**Available values:** "multipart", "single", "small_fallback" | *Enum:* `"multipart"`, `"single"`, `"small_fallback"` | Yes |
|
|
| multipart_part_count | integer | | No |
|
|
| multipart_part_size_bytes | integer | | No |
|
|
| status | string, <br>**Available values:** "aborted", "aborting", "completed", "completing", "creating", "expired", "failed", "ready" | *Enum:* `"aborted"`, `"aborting"`, `"completed"`, `"completing"`, `"creating"`, `"expired"`, `"failed"`, `"ready"` | Yes |
|
|
|
|
#### KnowledgeFileInfo
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_ids | [ string ] | | Yes |
|
|
|
|
#### KnowledgeFsAccessDeniedError
|
|
|
|
Agent Knowledge Base operation is not allowed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsAccessDeniedError | | Agent Knowledge Base operation is not allowed. | |
|
|
|
|
#### KnowledgeFsCitation
|
|
|
|
Immutable evidence identity; no signed URLs, tokens or storage keys.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| artifact_hash | string | | Yes |
|
|
| control_space_id | string | | Yes |
|
|
| document_asset_id | string | | Yes |
|
|
| document_title | string | | No |
|
|
| document_version | integer | | No |
|
|
| end_offset | integer | | No |
|
|
| id | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| page_number | integer | | No |
|
|
| parse_artifact_id | string | | No |
|
|
| section_path | [ string ] | | No |
|
|
| space_name | string | | Yes |
|
|
| start_offset | integer | | No |
|
|
|
|
#### KnowledgeFsConflictError
|
|
|
|
Agent Knowledge Base operation conflicts with the current resource state.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsConflictError | | Agent Knowledge Base operation conflicts with the current resource state. | |
|
|
|
|
#### KnowledgeFsInvalidRequestError
|
|
|
|
Agent Knowledge Base request is invalid.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsInvalidRequestError | | Agent Knowledge Base request is invalid. | |
|
|
|
|
#### KnowledgeFsOperationUnavailableError
|
|
|
|
Agent Knowledge Base operation is not available.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsOperationUnavailableError | | Agent Knowledge Base operation is not available. | |
|
|
|
|
#### KnowledgeFsRateLimitExceededError
|
|
|
|
Agent Knowledge Base request rate limit exceeded.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsRateLimitExceededError | | Agent Knowledge Base request rate limit exceeded. | |
|
|
|
|
#### KnowledgeFsRequestRejectedError
|
|
|
|
Agent Knowledge Base request was rejected.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsRequestRejectedError | | Agent Knowledge Base request was rejected. | |
|
|
|
|
#### KnowledgeFsRequestTooLargeError
|
|
|
|
Agent Knowledge Base request is too large.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsRequestTooLargeError | | Agent Knowledge Base request is too large. | |
|
|
|
|
#### KnowledgeFsResourceNotFoundError
|
|
|
|
Agent Knowledge Base resource was not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsResourceNotFoundError | | Agent Knowledge Base resource was not found. | |
|
|
|
|
#### KnowledgeFsSpaceNotFoundError
|
|
|
|
Agent Knowledge Base was not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsSpaceNotFoundError | | Agent Knowledge Base was not found. | |
|
|
|
|
#### KnowledgeFsUpgradeModelsUnavailableError
|
|
|
|
One or more selected upgrade models are unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsUpgradeModelsUnavailableError | | One or more selected upgrade models are unavailable. | |
|
|
|
|
#### KnowledgeFsUpstreamUnavailableError
|
|
|
|
Agent Knowledge Base is unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| KnowledgeFsUpstreamUnavailableError | | Agent Knowledge Base is unavailable. | |
|
|
|
|
#### KnowledgePipeline
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| publish_enabled | boolean | | Yes |
|
|
|
|
#### LLMMode
|
|
|
|
Enum class for large language model mode.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| LLMMode | string | Enum class for large language model mode. | |
|
|
|
|
#### LarkCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | Feishu or Lark application identifier. | Yes |
|
|
| app_secret | [_RequiredSecret](#_requiredsecret) | Feishu or Lark application secret. | Yes |
|
|
| encrypt_key | [_OptionalSecret](#_optionalsecret) | Optional callback encryption key. | No |
|
|
| provider | string | Lark credential discriminator. | Yes |
|
|
| verification_token | [_OptionalSecret](#_optionalsecret) | Optional callback verification token. | No |
|
|
|
|
#### LarkCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | [_Identifier](#_identifier)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| app_secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| encrypt_key | [_OptionalSecret](#_optionalsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
| verification_token | [_OptionalSecret](#_optionalsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
|
|
#### LatestPluginCache
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| alternative_plugin_id | string | | Yes |
|
|
| deprecated_reason | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| status | string, <br>**Available values:** "active", "deleted" | *Enum:* `"active"`, `"deleted"` | Yes |
|
|
| unique_identifier | string | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### LearnDifyAppListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| recommended_apps | [ [RecommendedAppResponse](#recommendedappresponse) ] | | Yes |
|
|
|
|
#### LegacyEndpointUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| endpoint_id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| settings | object | | Yes |
|
|
|
|
#### LegacyHITLv1NodeData
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_value | [ [DefaultValue](#defaultvalue) ] | | No |
|
|
| delivery_methods | [ [InteractiveSurfaceDeliveryMethod](#interactivesurfacedeliverymethod)<br>[EmailDeliveryMethod](#emaildeliverymethod)<br>[InstantMessageDeliveryMethod](#instantmessagedeliverymethod) ] | | No |
|
|
| desc | string | | No |
|
|
| error_strategy | [ErrorStrategy](#errorstrategy) | | No |
|
|
| form_content | string | | No |
|
|
| inputs | [ [FormInputConfig](#forminputconfig) ] | | No |
|
|
| retry_config | [RetryConfig](#retryconfig) | | No |
|
|
| timeout | integer, <br>**Default:** 36 | | No |
|
|
| timeout_unit | [TimeoutUnit](#timeoutunit) | | No |
|
|
| title | string | | No |
|
|
| type | [NodeType](#nodetype) | | No |
|
|
| user_actions | [ [UserActionConfig](#useractionconfig) ] | | No |
|
|
| version | string, <br>**Default:** 1 | | No |
|
|
|
|
#### LicenseLimitationModel
|
|
|
|
- enabled: whether this limit is enforced
|
|
- size: current usage count
|
|
- limit: maximum allowed count; 0 means unlimited
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | Whether this limit is currently active | Yes |
|
|
| limit | integer | Maximum number of resources allowed; 0 means no limit | Yes |
|
|
| size | integer | Number of resources already consumed | Yes |
|
|
|
|
#### LicenseModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expired_at | string | | Yes |
|
|
| license_expiry_notice_enabled | boolean | | Yes |
|
|
| seats | [LicenseLimitationModel](#licenselimitationmodel) | | Yes |
|
|
| status | [LicenseStatus](#licensestatus) | | Yes |
|
|
| workspaces | [LicenseLimitationModel](#licenselimitationmodel) | | Yes |
|
|
|
|
#### LicenseStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| LicenseStatus | string | | |
|
|
|
|
#### LicenseStatusModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| status | [LicenseStatus](#licensestatus) | | Yes |
|
|
|
|
#### LimitExceededError
|
|
|
|
Unable to create account because the licensed seats limit was exceeded
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| LimitExceededError | | Unable to create account because the licensed seats limit was exceeded | |
|
|
|
|
#### LimitationModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer | | Yes |
|
|
| size | integer | | Yes |
|
|
|
|
#### ListChannelProvidersResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email_providers | [ [ChannelProvider](#channelprovider) ] | | Yes |
|
|
| im_providers | [ [ChannelProvider](#channelprovider) ] | | Yes |
|
|
|
|
#### ListChannelsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channels | [ [ChannelSummary](#channelsummary) ] | | Yes |
|
|
|
|
#### ListContactOptionsResponse
|
|
|
|
Paginated editor-safe contact picker response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ContactOption](#contactoption) ] | Selectable contacts returned for the current page. | Yes |
|
|
| limit | integer | Page size used for the current query. | Yes |
|
|
| page | integer | Current 1-based page number. | Yes |
|
|
| total | integer | Total number of candidates matching the current query. | Yes |
|
|
|
|
#### ListContactsResponse
|
|
|
|
Paginated response body for contact list APIs.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [HumanInputContact](#humaninputcontact) ] | Contacts returned for the current page. | Yes |
|
|
| limit | integer | Page size used for the current query. | Yes |
|
|
| page | integer | Current 1-based page number. | Yes |
|
|
| total | integer | Total number of candidates matching the current query. | Yes |
|
|
|
|
#### ListIMIdentitiesQuery
|
|
|
|
Query params for searching synced IM identities.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Free-text search against identity display name, email, or provider user ID. | No |
|
|
| limit | integer, <br>**Default:** 20 | Maximum number of records returned per page. | No |
|
|
| page | integer, <br>**Default:** 1 | 1-based page number. | No |
|
|
|
|
#### ListIMIdentitiesResponse
|
|
|
|
Paginated response body for synced IM identity search.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [IMIdentity](#imidentity) ] | IM identities returned for the current page. | Yes |
|
|
| limit | integer | Page size used for the current query. | Yes |
|
|
| page | integer | Current 1-based page number. | Yes |
|
|
| total | integer | Total number of candidates matching the current query. | Yes |
|
|
|
|
#### ListLatestIMSyncRunResultsQuery
|
|
|
|
Query params for reading paginated latest-run results.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 20 | Maximum number of records returned per page. | No |
|
|
| page | integer, <br>**Default:** 1 | 1-based page number. | No |
|
|
| result | [IMSyncResultType](#imsyncresulttype) | Required result bucket to paginate from the latest sync run. There is no `all` bucket or unfiltered results mode. | Yes |
|
|
|
|
#### ListLatestIMSyncRunResultsResponse
|
|
|
|
Page-based latest-run results without cursor state or a repeated run summary.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [IMSyncResultItem](#imsyncresultitem) ] | Result entries returned with page, limit, and total metadata for the selected bucket. | Yes |
|
|
| limit | integer | Page size used for the current query. | Yes |
|
|
| page | integer | Current 1-based page number. | Yes |
|
|
| total | integer | Total number of candidates matching the current query. | Yes |
|
|
|
|
#### ListOrganizationCandidatesResponse
|
|
|
|
Paginated response body for organization candidate search.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [OrganizationCandidate](#organizationcandidate) ] | Organization member candidates returned for the current page. | Yes |
|
|
| limit | integer | Page size used for the current query. | Yes |
|
|
| page | integer | Current 1-based page number. | Yes |
|
|
| total | integer | Total number of candidates matching the current query. | Yes |
|
|
|
|
#### LoadBalancingCredentialPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### LoadBalancingCredentialValidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | No |
|
|
| result | string | | Yes |
|
|
|
|
#### LoadBalancingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| configs | [ object ] | | No |
|
|
| enabled | boolean | | No |
|
|
|
|
#### LoginPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| invite_token | string | Invitation token | No |
|
|
| password | string | | Yes |
|
|
| remember_me | boolean | Remember me flag | No |
|
|
|
|
#### LoopNodeRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | | No |
|
|
|
|
#### MCPAuthPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authorization_code | string | | No |
|
|
| provider_id | string | | Yes |
|
|
|
|
#### MCPAuthResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authorization_url | string | | No |
|
|
| result | string | | No |
|
|
|
|
#### MCPAuthentication
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | | Yes |
|
|
| client_secret | string | | No |
|
|
|
|
#### MCPCallbackQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| state | string | | Yes |
|
|
|
|
#### MCPConfiguration
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| sse_read_timeout | number, <br>**Default:** 300 | | No |
|
|
| timeout | number, <br>**Default:** 30 | | No |
|
|
|
|
#### MCPProviderCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authentication | [MCPAuthentication](#mcpauthentication) | | No |
|
|
| configuration | [MCPConfiguration](#mcpconfiguration) | | No |
|
|
| headers | object | | No |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | Yes |
|
|
| identity_mode | [IdentityMode](#identitymode) | | No |
|
|
| name | string | | Yes |
|
|
| server_identifier | string | | Yes |
|
|
| server_url | string | | Yes |
|
|
|
|
#### MCPProviderDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| provider_id | string | | Yes |
|
|
|
|
#### MCPProviderUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authentication | [MCPAuthentication](#mcpauthentication) | | No |
|
|
| configuration | [MCPConfiguration](#mcpconfiguration) | | No |
|
|
| headers | object | | No |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | Yes |
|
|
| identity_mode | [IdentityMode](#identitymode) | | No |
|
|
| name | string | | Yes |
|
|
| provider_id | string | | Yes |
|
|
| server_identifier | string | | Yes |
|
|
| server_url | string | | Yes |
|
|
|
|
#### MCPServerCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | Server description | No |
|
|
| parameters | object | Server parameters configuration | Yes |
|
|
|
|
#### MCPServerUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | Server description | No |
|
|
| id | string (uuid) | Server ID | Yes |
|
|
| parameters | object | Server parameters configuration | Yes |
|
|
| status | [AppMCPServerStatus](#appmcpserverstatus) | Server status | No |
|
|
|
|
#### MSTeamsCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | Microsoft Teams application client identifier. | Yes |
|
|
| client_secret | [_RequiredSecret](#_requiredsecret) | Microsoft Teams application client secret. | Yes |
|
|
| provider | string | Microsoft Teams credential discriminator. | Yes |
|
|
| tenant_id | string | Microsoft Entra tenant identifier. | Yes |
|
|
|
|
#### MSTeamsCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | | Yes |
|
|
| client_secret | [Redacted](#redacted) | | Yes |
|
|
| provider | string | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### MSTeamsCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | [_UUIDString](#_uuidstring)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| client_secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
| tenant_id | [_UUIDString](#_uuidstring)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
|
|
#### MarkdownFragment
|
|
|
|
One source-ordered Markdown fragment in a resolved form.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| text | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### MaxKeysExceededError
|
|
|
|
The API key limit has been reached.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MaxKeysExceededError | | The API key limit has been reached. | |
|
|
|
|
#### MemberActionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### MemberBindingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AccessPolicyMemberBinding](#accesspolicymemberbinding) ] | | No |
|
|
|
|
#### MemberInviteAlreadyMemberResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| message | string | | Yes |
|
|
| status | string | | Yes |
|
|
|
|
#### MemberInviteErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string, <br>**Available values:** "invalid_param", "invalid_role", "limit_exceeded" | *Enum:* `"invalid_param"`, `"invalid_role"`, `"limit_exceeded"` | Yes |
|
|
| message | string | | Yes |
|
|
| status | integer | | Yes |
|
|
|
|
#### MemberInviteFailedResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| message | string | | Yes |
|
|
| status | string | | Yes |
|
|
|
|
#### MemberInvitePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| emails | [ string ] | | Yes |
|
|
| language | string | | No |
|
|
| role | string | | Yes |
|
|
|
|
#### MemberInviteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| invitation_results | [ [MemberInviteSuccessResponse](#memberinvitesuccessresponse)<br>[MemberInviteAlreadyMemberResponse](#memberinvitealreadymemberresponse)<br>[MemberInviteFailedResponse](#memberinvitefailedresponse) ] | | Yes |
|
|
| result | string | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### MemberInviteSuccessResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| status | string | | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### MemberNotFoundError
|
|
|
|
Member not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MemberNotFoundError | | Member not found. | |
|
|
|
|
#### MemberNotInTenantError
|
|
|
|
The member is not in the workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MemberNotInTenantError | | The member is not in the workspace. | |
|
|
|
|
#### MemberRoleSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### MemberRoleUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| role | string | | Yes |
|
|
|
|
#### MemberRolesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | Yes |
|
|
| roles | [ [RBACRole](#rbacrole) ] | | No |
|
|
|
|
#### MembersInRole
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | No |
|
|
| account_name | string | | No |
|
|
|
|
#### MessageCursorNotFoundError
|
|
|
|
The message cursor is not in this conversation. Refresh the list and try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MessageCursorNotFoundError | | The message cursor is not in this conversation. Refresh the list and try again. | |
|
|
|
|
#### MessageDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_thoughts | [ [AgentThought](#agentthought) ] | | Yes |
|
|
| annotation | [ConversationAnnotation](#conversationannotation) | | No |
|
|
| annotation_hit_history | [ConversationAnnotationHitHistory](#conversationannotationhithistory) | | No |
|
|
| answer | string | | Yes |
|
|
| answer_tokens | integer | | Yes |
|
|
| conversation_id | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| error | string | | No |
|
|
| feedbacks | [ [Feedback](#feedback) ] | | Yes |
|
|
| from_account_id | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| id | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
| message | [AnyJSONValue](#anyjsonvalue) | | Yes |
|
|
| message_files | [ [MessageFile](#messagefile) ] | | Yes |
|
|
| message_tokens | integer | | Yes |
|
|
| metadata | [AnyJSONValue](#anyjsonvalue) | | Yes |
|
|
| parent_message_id | string | | No |
|
|
| provider_response_latency | number | | Yes |
|
|
| query | string | | Yes |
|
|
| retriever_resources | [ [RetrievalSourceMetadata](#retrievalsourcemetadata) ] | | No |
|
|
| status | string | | Yes |
|
|
| workflow_run_id | string | | No |
|
|
|
|
#### MessageDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_thoughts | [ [AgentThought](#agentthought) ] | | Yes |
|
|
| annotation | [ConversationAnnotation](#conversationannotation) | | No |
|
|
| annotation_hit_history | [ConversationAnnotationHitHistory](#conversationannotationhithistory) | | No |
|
|
| answer | string | | Yes |
|
|
| answer_tokens | integer | | Yes |
|
|
| conversation_id | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| error | string | | No |
|
|
| extra_contents | [ [HumanInputContent](#humaninputcontent) ] | | No |
|
|
| feedbacks | [ [Feedback](#feedback) ] | | Yes |
|
|
| from_account_id | string | | No |
|
|
| from_end_user_id | string | | No |
|
|
| from_source | string | | Yes |
|
|
| id | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
| message | [AnyJSONValue](#anyjsonvalue) | | Yes |
|
|
| message_files | [ [MessageFile](#messagefile) ] | | Yes |
|
|
| message_tokens | integer | | Yes |
|
|
| metadata | [AnyJSONValue](#anyjsonvalue) | | Yes |
|
|
| parent_message_id | string | | No |
|
|
| provider_response_latency | number | | Yes |
|
|
| query | string | | Yes |
|
|
| retriever_resources | [ [RetrievalSourceMetadata](#retrievalsourcemetadata) ] | | No |
|
|
| status | string | | Yes |
|
|
| workflow_run_id | string | | No |
|
|
|
|
#### MessageFeedbackPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Optional text feedback providing additional detail. | No |
|
|
| rating | string, <br>**Available values:** "dislike", "like" | Feedback rating. Set to `null` to revoke previously submitted feedback. | No |
|
|
|
|
#### MessageFeedbackRatingRequiredError
|
|
|
|
A rating is required when there is no existing feedback to remove.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MessageFeedbackRatingRequiredError | | A rating is required when there is no existing feedback to remove. | |
|
|
|
|
#### MessageFile
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| belongs_to | string | | No |
|
|
| filename | string | | Yes |
|
|
| id | string (uuid) | | Yes |
|
|
| mime_type | string | | No |
|
|
| size | integer | | No |
|
|
| transfer_method | string | | Yes |
|
|
| type | string | | Yes |
|
|
| upload_file_id | string | | No |
|
|
| url | string | | No |
|
|
|
|
#### MessageInfiniteScrollPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [MessageDetailResponse](#messagedetailresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
|
|
#### MessageListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_id | string | Conversation ID. | Yes |
|
|
| first_id | string | The ID of the first chat record on the current page. Omit this value to fetch the latest messages; for subsequent pages, use the first message ID from the current list to fetch older messages. | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of chat history messages to return per request. | No |
|
|
|
|
#### MessageNotFoundError
|
|
|
|
The message was not found for this account and app.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MessageNotFoundError | | The message was not found for this account and app. | |
|
|
|
|
#### MessageTemplateConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| body | string | | Yes |
|
|
| subject | string | | Yes |
|
|
|
|
#### MessageTemplateTestRequest
|
|
|
|
Request body for sending one message-template test notification.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| channel | [DebugChannel](#debugchannel) | Target debug delivery channel used for the test send. | Yes |
|
|
| inputs | object | Variable values used when rendering the message template preview. | No |
|
|
|
|
#### MessageTemplateTestResponse
|
|
|
|
Response body returned after one message-template test send.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
|
|
#### Meta
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| minimum_dify_version | string | | No |
|
|
| version | string | | No |
|
|
|
|
#### MetadataArgs
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | Metadata field name. | Yes |
|
|
| type | string, <br>**Available values:** "number", "string", "time" | `string` for text values, `number` for numeric values, `time` for date/time values.<br>*Enum:* `"number"`, `"string"`, `"time"` | Yes |
|
|
|
|
#### MetadataDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string (uuid) | Metadata field ID. | Yes |
|
|
| name | string | Metadata field name. | Yes |
|
|
| value | string<br>integer<br>number | Metadata value. Can be a string, number, or `null`. | No |
|
|
|
|
#### MetadataFilteringCondition
|
|
|
|
Metadata Filtering Condition.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conditions | [ [Condition](#condition) ] | List of metadata conditions to evaluate. | No |
|
|
| logical_operator | string, <br>**Available values:** "and", "or" | How to combine multiple conditions. | No |
|
|
|
|
#### MetadataOperationData
|
|
|
|
Metadata operation data
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| operation_data | [ [DocumentMetadataOperation](#documentmetadataoperation) ] | Array of document metadata update operations. Each entry maps a document ID to its metadata values. | Yes |
|
|
|
|
#### MetadataUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | New metadata field name. | Yes |
|
|
|
|
#### MissingInvitationCodeError
|
|
|
|
Invitation code is required.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| MissingInvitationCodeError | | Invitation code is required. | |
|
|
|
|
#### Model
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| llm | boolean | | No |
|
|
| moderation | boolean | | No |
|
|
| rerank | boolean | | No |
|
|
| speech2text | boolean | | No |
|
|
| text_embedding | boolean | | No |
|
|
| tts | boolean | | No |
|
|
|
|
#### ModelConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | object | | No |
|
|
| mode | [LLMMode](#llmmode) | | Yes |
|
|
| name | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### ModelConfigPartial
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| model | [AppModelSelectionResponse](#appmodelselectionresponse) | | No |
|
|
| pre_prompt | string | | No |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
|
|
#### ModelCredentialResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available_credentials | [ [CredentialConfiguration](#credentialconfiguration) ] | | Yes |
|
|
| credentials | object | | Yes |
|
|
| current_credential_id | string | | No |
|
|
| current_credential_name | string | | No |
|
|
| load_balancing | [ModelLoadBalancingResponse](#modelloadbalancingresponse) | | Yes |
|
|
|
|
#### ModelCredentialSchema
|
|
|
|
Model class for model credential schema.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_form_schemas | [ [CredentialFormSchema](#credentialformschema) ] | | Yes |
|
|
| model | [FieldModelSchema](#fieldmodelschema) | | Yes |
|
|
|
|
#### ModelCurrentlyNotSupportError
|
|
|
|
Dify Hosted OpenAI trial currently not support the GPT-4 model.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ModelCurrentlyNotSupportError | | Dify Hosted OpenAI trial currently not support the GPT-4 model. | |
|
|
|
|
#### ModelFeature
|
|
|
|
Enum class for llm feature.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ModelFeature | string | Enum class for llm feature. | |
|
|
|
|
#### ModelLoadBalancingConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
| credentials | object | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| in_cooldown | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| ttl | integer | | Yes |
|
|
|
|
#### ModelLoadBalancingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| configs | [ [ModelLoadBalancingConfigResponse](#modelloadbalancingconfigresponse) ] | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
|
|
#### ModelParameterRuleListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ParameterRule](#parameterrule) ] | | Yes |
|
|
|
|
#### ModelPropertyKey
|
|
|
|
Enum class for model property key.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ModelPropertyKey | string | Enum class for model property key. | |
|
|
|
|
#### ModelProviderCreditsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| exhausted_at | integer | | Yes |
|
|
| is_exhausted | boolean | | Yes |
|
|
| is_unlimited | boolean | | Yes |
|
|
| next_credit_reset_date | integer | | Yes |
|
|
| pool_type | string, <br>**Available values:** "paid", "trial" | | Yes |
|
|
| quota_limit | integer | Credit limit for the effective pool; -1 means unlimited. | Yes |
|
|
| quota_used | integer | | Yes |
|
|
| remaining_credits | integer | Remaining credits; -1 means unlimited. | Yes |
|
|
|
|
#### ModelProviderCustomConfigurationSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| available_credentials | [ [CredentialConfiguration](#credentialconfiguration) ] | | Yes |
|
|
| current_credential_id | string | | No |
|
|
| current_credential_name | string | | No |
|
|
| current_credential_usable | boolean | | Yes |
|
|
| has_custom_models | boolean | Whether custom model configuration exists, including saved model credentials. | Yes |
|
|
| status | [CustomConfigurationStatus](#customconfigurationstatus) | | Yes |
|
|
|
|
#### ModelProviderListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ProviderResponse](#providerresponse) ] | | Yes |
|
|
|
|
#### ModelProviderPaymentCheckoutUrlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| payment_link | string | | Yes |
|
|
|
|
#### ModelProviderPluginSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| installation_id | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| runtime_type | string | | Yes |
|
|
| source | [PluginInstallationSource](#plugininstallationsource) | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### ModelProviderSummaryListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ModelProviderSummaryResponse](#modelprovidersummaryresponse) ] | | Yes |
|
|
| plugins | object | | Yes |
|
|
|
|
#### ModelProviderSummaryResponse
|
|
|
|
Fields required to render the collapsed model-provider list.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| configurate_methods | [ [ConfigurateMethod](#configuratemethod) ] | | Yes |
|
|
| custom_configuration | [ModelProviderCustomConfigurationSummaryResponse](#modelprovidercustomconfigurationsummaryresponse) | | Yes |
|
|
| description | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| is_configured | boolean | | Yes |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| preferred_provider_type | [ProviderType](#providertype) | | Yes |
|
|
| provider | string | | Yes |
|
|
| supported_model_types | [ [ModelType](#modeltype) ] | | Yes |
|
|
| system_configuration | [ModelProviderSystemConfigurationSummaryResponse](#modelprovidersystemconfigurationsummaryresponse) | | Yes |
|
|
|
|
#### ModelProviderSystemConfigurationSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | Yes |
|
|
|
|
#### ModelRuntimeI18nObject
|
|
|
|
Model class for i18n object.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| en_US | string | | Yes |
|
|
| zh_Hans | string | | No |
|
|
|
|
#### ModelSelectorScope
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ModelSelectorScope | string | | |
|
|
|
|
#### ModelStatus
|
|
|
|
Enum class for model status.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ModelStatus | string | Enum class for model status. | |
|
|
|
|
#### ModelType
|
|
|
|
Enum class for model type.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ModelType | string | Enum class for model type. | |
|
|
|
|
#### ModelWithProviderEntityResponse
|
|
|
|
Model with provider entity.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deprecated | boolean | | No |
|
|
| features | [ [ModelFeature](#modelfeature) ] | | No |
|
|
| fetch_from | [FetchFrom](#fetchfrom) | Where the model definition comes from. `predefined-model` for built-in models, `customizable-model` for user-configured models. | Yes |
|
|
| has_invalid_load_balancing_configs | boolean | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | Localized display name of the model. | Yes |
|
|
| load_balancing_enabled | boolean | | No |
|
|
| model | string | | Yes |
|
|
| model_properties | object | | Yes |
|
|
| model_type | [ModelType](#modeltype) | Type of the model, matching the `model_type` path parameter. | Yes |
|
|
| provider | [SimpleProviderEntityResponse](#simpleproviderentityresponse) | | Yes |
|
|
| status | [ModelStatus](#modelstatus) | Model availability status. `active` when ready to use. | Yes |
|
|
|
|
#### MoreLikeThisQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| response_mode | string, <br>**Available values:** "blocking", "streaming" | *Enum:* `"blocking"`, `"streaming"` | Yes |
|
|
|
|
#### MyPermissionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent | [ResourcePermissionSnapshot](#resourcepermissionsnapshot) | | No |
|
|
| app | [ResourcePermissionSnapshot](#resourcepermissionsnapshot) | | No |
|
|
| dataset | [ResourcePermissionSnapshot](#resourcepermissionsnapshot) | | No |
|
|
| workspace | [WorkspacePermissionSnapshot](#workspacepermissionsnapshot) | | No |
|
|
|
|
#### NeedAddIdsError
|
|
|
|
Need to add ids.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NeedAddIdsError | | Need to add ids. | |
|
|
|
|
#### NetworkAccessForbiddenError
|
|
|
|
Network access groups are not available for this workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessForbiddenError | | Network access groups are not available for this workspace. | |
|
|
|
|
#### NetworkAccessGroupAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| bound_agent_id | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| id | string | | Yes |
|
|
| mode | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### NetworkAccessGroupBoundError
|
|
|
|
This IP policy is still used by one or more apps.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessGroupBoundError | | This IP policy is still used by one or more apps. | |
|
|
|
|
#### NetworkAccessGroupCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_cidrs | [ string ] | | Yes |
|
|
| description | string | | No |
|
|
| name | string | | Yes |
|
|
|
|
#### NetworkAccessGroupCurrentIPCheckResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed | boolean | | Yes |
|
|
| client_ip | string | | Yes |
|
|
| policy_version | integer | | Yes |
|
|
|
|
#### NetworkAccessGroupCurrentIPResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_ip | string | | Yes |
|
|
|
|
#### NetworkAccessGroupDeleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deleted | boolean | | Yes |
|
|
|
|
#### NetworkAccessGroupListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| entitled | boolean | | Yes |
|
|
| groups | [ [NetworkAccessGroupResponse](#networkaccessgroupresponse) ] | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### NetworkAccessGroupMutationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| group | [NetworkAccessGroupResponse](#networkaccessgroupresponse) | | Yes |
|
|
|
|
#### NetworkAccessGroupNameConflictError
|
|
|
|
An IP policy with this name already exists.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessGroupNameConflictError | | An IP policy with this name already exists. | |
|
|
|
|
#### NetworkAccessGroupNotFoundError
|
|
|
|
Network access group was not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessGroupNotFoundError | | Network access group was not found. | |
|
|
|
|
#### NetworkAccessGroupResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_cidrs | [ string ] | | Yes |
|
|
| app_ids | [ string ] | | Yes |
|
|
| apps | [ [NetworkAccessGroupAppResponse](#networkaccessgroupappresponse) ] | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| description | string | | No |
|
|
| enforcing_count | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| updated_by_account_id | string | | No |
|
|
| used_by_count | integer | | Yes |
|
|
| version | integer | | Yes |
|
|
|
|
#### NetworkAccessGroupUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_cidrs | [ string ] | | Yes |
|
|
| description | string | | No |
|
|
| expected_version | integer | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### NetworkAccessInvalidInputError
|
|
|
|
Invalid network access group request.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessInvalidInputError | | Invalid network access group request. | |
|
|
|
|
#### NetworkAccessNotEntitledError
|
|
|
|
Network access groups are not available for this workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessNotEntitledError | | Network access groups are not available for this workspace. | |
|
|
|
|
#### NetworkAccessRoleDeniedError
|
|
|
|
Your workspace role does not allow this network access operation.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessRoleDeniedError | | Your workspace role does not allow this network access operation. | |
|
|
|
|
#### NetworkAccessUnsupportedAccessPointsError
|
|
|
|
Some access points are not supported for this app.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessUnsupportedAccessPointsError | | Some access points are not supported for this app. | |
|
|
|
|
#### NetworkAccessUnsupportedAppModeError
|
|
|
|
Network access control is not supported for this app mode.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessUnsupportedAppModeError | | Network access control is not supported for this app mode. | |
|
|
|
|
#### NetworkAccessVersionConflictError
|
|
|
|
The network access resource changed. Refresh it and try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NetworkAccessVersionConflictError | | The network access resource changed. Refresh it and try again. | |
|
|
|
|
#### NewAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_app_id | string | | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
|
|
#### NoActiveBindingError
|
|
|
|
No active sandbox binding.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NoActiveBindingError | | No active sandbox binding. | |
|
|
|
|
#### NoAudioUploadedError
|
|
|
|
Please upload your audio.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NoAudioUploadedError | | Please upload your audio. | |
|
|
|
|
#### NoFileUploadedError
|
|
|
|
Please upload your file.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NoFileUploadedError | | Please upload your file. | |
|
|
|
|
#### Node
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
|
|
#### NodeDataMigrationBlocker
|
|
|
|
Stable node-scoped reason why the backend cannot produce lossless v2 data.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string, <br>**Available values:** "configured-disabled-method", "conflicting-email-templates", "invalid-default-value", "invalid-email", "invalid-email-configuration", "missing-recipients", "unresolved-member", "unsupported-delivery-method", "unsupported-version" | Machine-readable migration blocker code.<br>*Enum:* `"configured-disabled-method"`, `"conflicting-email-templates"`, `"invalid-default-value"`, `"invalid-email"`, `"invalid-email-configuration"`, `"missing-recipients"`, `"unresolved-member"`, `"unsupported-delivery-method"`, `"unsupported-version"` | Yes |
|
|
| method_id | string | Legacy delivery method related to the blocker. | No |
|
|
| node_id | string | The identifier of the node that failed migration. | Yes |
|
|
| node_title | string | The node title used for actionable frontend feedback. | Yes |
|
|
| value | string | Safe legacy value related to the blocker. | No |
|
|
|
|
#### NodeDataMigrationFailureResponse
|
|
|
|
Whole-batch failure response without partial converted node data.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| blockers | [ [NodeDataMigrationBlocker](#nodedatamigrationblocker) ] | Node-scoped blockers that caused the whole batch to fail. | Yes |
|
|
| code | string, <br>**Default:** hitl_node_data_migration_failure | | No |
|
|
| message | string | overall error messages | Yes |
|
|
| status | integer, <br>**Default:** 400 | | No |
|
|
|
|
#### NodeDataMigrationInput
|
|
|
|
One legacy node submitted through the frontend migration adapter boundary.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_data | [LegacyHITLv1NodeData](#legacyhitlv1nodedata) | The legacy Human Input node data to migrate. | Yes |
|
|
| node_id | string | The identifier of node to migrate. Used to associate between request and response | Yes |
|
|
|
|
#### NodeDataMigrationPayload
|
|
|
|
Complete legacy-node batch submitted for one migration attempt.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| nodes | [ [NodeDataMigrationInput](#nodedatamigrationinput) ] | | Yes |
|
|
|
|
#### NodeDataMigrationResponse
|
|
|
|
Successful all-node conversion response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [NodeDataMigrationResult](#nodedatamigrationresult) ] | | Yes |
|
|
|
|
#### NodeDataMigrationResult
|
|
|
|
One converted node returned with its frontend correlation identifier.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_data | [HumanInputNodeData](#humaninputnodedata) | The complete converted Human Input v2 node data. | Yes |
|
|
| node_id | string | The identifier of the migrated node. | Yes |
|
|
|
|
#### NodeIdQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_id | string | | Yes |
|
|
|
|
#### NodeNotInWorkflowRunError
|
|
|
|
The node is not part of this workflow run.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NodeNotInWorkflowRunError | | The node is not part of this workflow run. | |
|
|
|
|
#### NodeOutputNotDeclaredError
|
|
|
|
The node does not declare this output.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NodeOutputNotDeclaredError | | The node does not declare this output. | |
|
|
|
|
#### NodeOutputStatus
|
|
|
|
Lifecycle status of a single declared output within a run.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NodeOutputStatus | string | Lifecycle status of a single declared output within a run. | |
|
|
|
|
#### NodeOutputView
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| output_check | [CheckResultView](#checkresultview) | | No |
|
|
| retried | integer | | No |
|
|
| status | [NodeOutputStatus](#nodeoutputstatus) | | Yes |
|
|
| type | [DeclaredOutputType](#declaredoutputtype) | | No |
|
|
| type_check | [CheckResultView](#checkresultview) | | No |
|
|
| value_preview | | | No |
|
|
|
|
#### NodeOutputsView
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_completed_at | string | | No |
|
|
| node_display_name | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| node_kind | string | | Yes |
|
|
| node_started_at | string | | No |
|
|
| node_status | [NodeStatus](#nodestatus) | | Yes |
|
|
| outputs | [ [NodeOutputView](#nodeoutputview) ] | | No |
|
|
|
|
#### NodeRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | | No |
|
|
|
|
#### NodeRunRequiredPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | | Yes |
|
|
|
|
#### NodeStatus
|
|
|
|
Coarse node-level status used by Inspector to pick a banner.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NodeStatus | string | Coarse node-level status used by Inspector to pick a banner. | |
|
|
|
|
#### NodeType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NodeType | string | | |
|
|
|
|
#### NormalizedEmailAlreadyInUseError
|
|
|
|
An account with an equivalent email address already exists.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NormalizedEmailAlreadyInUseError | | An account with an equivalent email address already exists. | |
|
|
|
|
#### NotAllowedCreateWorkspaceError
|
|
|
|
Workspace not found, please contact system admin to invite you to join in a workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NotAllowedCreateWorkspaceError | | Workspace not found, please contact system admin to invite you to join in a workspace. | |
|
|
|
|
#### NotChatAppError
|
|
|
|
App mode is invalid.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NotChatAppError | | App mode is invalid. | |
|
|
|
|
#### NotCompletionAppError
|
|
|
|
Not Completion App
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NotCompletionAppError | | Not Completion App | |
|
|
|
|
#### NotOwnerError
|
|
|
|
You are not the owner of the workspace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NotOwnerError | | You are not the owner of the workspace. | |
|
|
|
|
#### NotWorkflowAppError
|
|
|
|
Only support workflow app.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NotWorkflowAppError | | Only support workflow app. | |
|
|
|
|
#### NotificationItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| body | string | | Yes |
|
|
| frequency | string, <br>**Available values:** "every_page_load", "once" | *Enum:* `"every_page_load"`, `"once"` | Yes |
|
|
| lang | string | | Yes |
|
|
| notification_id | string | | Yes |
|
|
| subtitle | string | | Yes |
|
|
| title | string | | Yes |
|
|
| title_pic_url | string | | Yes |
|
|
|
|
#### NotificationQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Default:** en-US | Notification language | No |
|
|
|
|
#### NotificationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| notifications | [ [NotificationItemResponse](#notificationitemresponse) ] | | Yes |
|
|
| should_show | boolean | | Yes |
|
|
|
|
#### NotionEstimatePagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page_id | string | | Yes |
|
|
| type | [NotionPageType](#notionpagetype) | | Yes |
|
|
|
|
#### NotionEstimatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| doc_form | string, <br>**Default:** text_model | | No |
|
|
| doc_language | string, <br>**Default:** English | | No |
|
|
| notion_info_list | [ [NotionEstimateWorkspacePayload](#notionestimateworkspacepayload) ] | | Yes |
|
|
| process_rule | object | | Yes |
|
|
|
|
#### NotionEstimateWorkspacePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| pages | [ [NotionEstimatePagePayload](#notionestimatepagepayload) ] | | Yes |
|
|
| workspace_id | string | | Yes |
|
|
|
|
#### NotionIcon
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| emoji | string | | No |
|
|
| type | string | | Yes |
|
|
| url | string | | No |
|
|
|
|
#### NotionInfo
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| pages | [ [NotionPage](#notionpage) ] | | Yes |
|
|
| workspace_id | string | | Yes |
|
|
|
|
#### NotionIntegrateInfoListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| notion_info | [ [NotionIntegrateWorkspaceResponse](#notionintegrateworkspaceresponse) ] | | Yes |
|
|
|
|
#### NotionIntegratePageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| is_bound | boolean | | Yes |
|
|
| page_icon | [DataSourceIntegrateIconResponse](#datasourceintegrateiconresponse) | | Yes |
|
|
| page_id | string | | Yes |
|
|
| page_name | string | | Yes |
|
|
| parent_id | string | | Yes |
|
|
| type | [NotionPageType](#notionpagetype) | | Yes |
|
|
|
|
#### NotionIntegrateWorkspaceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| pages | [ [NotionIntegratePageResponse](#notionintegratepageresponse) ] | | Yes |
|
|
| workspace_icon | string | | Yes |
|
|
| workspace_id | string | | Yes |
|
|
| workspace_name | string | | Yes |
|
|
|
|
#### NotionPage
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page_icon | [NotionIcon](#notionicon) | | No |
|
|
| page_id | string | | Yes |
|
|
| page_name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### NotionPageType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| NotionPageType | string | | |
|
|
|
|
#### OAuthCallbackQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | Authorization code from OAuth provider | Yes |
|
|
| state | string | OAuth state parameter | No |
|
|
|
|
#### OAuthClientPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | | Yes |
|
|
|
|
#### OAuthDataSourceBindingQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | Authorization code from OAuth provider | Yes |
|
|
|
|
#### OAuthDataSourceBindingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Operation result | Yes |
|
|
|
|
#### OAuthDataSourceCallbackQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | Authorization code from OAuth provider | No |
|
|
| error | string | Error message from OAuth provider | No |
|
|
|
|
#### OAuthDataSourceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | string | Authorization URL or 'internal' for internal setup | Yes |
|
|
|
|
#### OAuthDataSourceSyncResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Operation result | Yes |
|
|
|
|
#### OAuthErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | OAuth error message | Yes |
|
|
|
|
#### OAuthLoginQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| invite_token | string | Optional invitation token | No |
|
|
| language | string | Preferred interface language | No |
|
|
| redirect_url | string | Relative page to resume after login | No |
|
|
| timezone | string | Preferred timezone | No |
|
|
|
|
#### OAuthProviderAccountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| created_at | integer | | Yes |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| interface_language | string | | Yes |
|
|
| name | string | | Yes |
|
|
| timezone | string | | Yes |
|
|
|
|
#### OAuthProviderAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_icon | string | | Yes |
|
|
| app_label | object | | Yes |
|
|
| auto_authorize | boolean | | Yes |
|
|
| scope | string | | Yes |
|
|
|
|
#### OAuthProviderAuthorizeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
|
|
#### OAuthProviderRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | | Yes |
|
|
| redirect_uri | string | | Yes |
|
|
|
|
#### OAuthProviderTokenResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_token | string | | Yes |
|
|
| expires_in | integer | | Yes |
|
|
| refresh_token | string | | Yes |
|
|
| token_type | string | | Yes |
|
|
|
|
#### OAuthSchema
|
|
|
|
OAuth schema
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_schema | [ [ProviderConfig](#providerconfig) ] | client schema like client_id, client_secret, etc. | No |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | credentials schema like access_token, refresh_token, etc. | No |
|
|
|
|
#### OAuthTokenRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_id | string | | Yes |
|
|
| client_secret | string | | No |
|
|
| code | string | | No |
|
|
| grant_type | string | | Yes |
|
|
| redirect_uri | string | | No |
|
|
| refresh_token | string | | No |
|
|
|
|
#### OnetimeEmail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| type | string, <br>**Default:** onetime_email | | No |
|
|
|
|
#### Option
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | [I18nObject](#i18nobject) | The label of the option | Yes |
|
|
| value | string | The value of the option | Yes |
|
|
|
|
#### OrganizationCandidate
|
|
|
|
One organization member candidate that may become a platform contact.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | Signed avatar URL if one is available. | No |
|
|
| email | string | Primary organization email used for matching. | Yes |
|
|
| id | string | Organization candidate identifier. | Yes |
|
|
| name | string | Display name shown in the candidate list. | Yes |
|
|
|
|
#### OrganizationCandidatesQuery
|
|
|
|
Query params for searching organization member candidates.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Free-text search against candidate name or email. | No |
|
|
| limit | integer, <br>**Default:** 20 | Maximum number of records returned per page. | No |
|
|
| page | integer, <br>**Default:** 1 | 1-based page number. | No |
|
|
|
|
#### OutputErrorStrategy
|
|
|
|
Per-output failure handling strategy.
|
|
|
|
Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of
|
|
a Workflow Agent Node. The runtime applies the strategy after type check or
|
|
output check fails and any configured retry attempts have been exhausted.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| OutputErrorStrategy | string | Per-output failure handling strategy. Mirrors ``graphon.ErrorStrategy`` but scoped to a single declared output of a Workflow Agent Node. The runtime applies the strategy after type check or output check fails and any configured retry attempts have been exhausted. | |
|
|
|
|
#### OutputPreviewView
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_id | string | | Yes |
|
|
| output_name | string | | Yes |
|
|
| status | [NodeOutputStatus](#nodeoutputstatus) | | Yes |
|
|
| type | [DeclaredOutputType](#declaredoutputtype) | | No |
|
|
| value | | | No |
|
|
|
|
#### OwnerTransferCheckPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### OwnerTransferEmailPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string | | No |
|
|
|
|
#### OwnerTransferLimitError
|
|
|
|
Too many failed owner transfer attempts. Please try again in 24 hours.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| OwnerTransferLimitError | | Too many failed owner transfer attempts. Please try again in 24 hours. | |
|
|
|
|
#### OwnerTransferPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| token | string | | Yes |
|
|
|
|
#### OwnerTransferRateLimitExceededError
|
|
|
|
Too many owner transfer emails have been sent. Please try again in {minutes} minutes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| OwnerTransferRateLimitExceededError | | Too many owner transfer emails have been sent. Please try again in {minutes} minutes. | |
|
|
|
|
#### PaginatedConversationVariableResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ConversationVariableResponse](#conversationvariableresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### Pagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_page | integer | | No |
|
|
| per_page | integer | | No |
|
|
| total_count | integer | | No |
|
|
| total_pages | integer | | No |
|
|
|
|
#### PaginationQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### PaidPlanRequiredError
|
|
|
|
This feature requires a paid plan.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PaidPlanRequiredError | | This feature requires a paid plan. | |
|
|
|
|
#### ParagraphInput
|
|
|
|
Resolved multiline text input.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_value | string | | Yes |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### ParagraphInputConfig
|
|
|
|
Form input definition.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | [StringSource](#stringsource) | Raw default-value configuration for the paragraph input. Runtime-resolved values are exposed in the surrounding `resolved_default_values` mapping. | No |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### ParameterRule
|
|
|
|
Model class for parameter rule.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | | | No |
|
|
| help | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| max | number | | No |
|
|
| min | number | | No |
|
|
| name | string | | Yes |
|
|
| options | [ string ], <br>**Default:** | | No |
|
|
| precision | integer | | No |
|
|
| required | boolean | | No |
|
|
| type | [ParameterType](#parametertype) | | Yes |
|
|
| use_template | string | | No |
|
|
|
|
#### ParameterType
|
|
|
|
Enum class for parameter type.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ParameterType | string | Enum class for parameter type. | |
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_reply | { **"enabled"**: boolean } | | Yes |
|
|
| file_upload | { **"allowed_file_extensions"**: [ string ], **"allowed_file_types"**: [ string, <br>**Available values:** "audio", "custom", "document", "image", "video" ], **"allowed_file_upload_methods"**: [ string, <br>**Available values:** "local_file", "remote_url" ], **"enabled"**: boolean, **"image"**: { **"detail"**: string, **"enabled"**: boolean, **"number_limits"**: integer, **"transfer_methods"**: [ string ] }, **"number_limits"**: integer } | | Yes |
|
|
| more_like_this | { **"enabled"**: boolean } | | Yes |
|
|
| opening_statement | | | No |
|
|
| retriever_resource | { **"enabled"**: boolean } | | Yes |
|
|
| sensitive_word_avoidance | { **"enabled"**: boolean } | | Yes |
|
|
| speech_to_text | { **"enabled"**: boolean } | | Yes |
|
|
| suggested_questions | [ string ] | | Yes |
|
|
| suggested_questions_after_answer | { **"enabled"**: boolean } | | Yes |
|
|
| system_parameters | [SystemParameters](#systemparameters) | System-level parameter limits. | Yes |
|
|
| text_to_speech | { **"autoPlay"**: string, **"enabled"**: boolean, **"language"**: string, **"voice"**: string } | | Yes |
|
|
| user_input_form | [ object ] | | Yes |
|
|
|
|
#### ParserAsset
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_name | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
|
|
#### ParserAutoUpgradeChange
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_upgrade | [PluginAutoUpgradeSettingsPayload](#pluginautoupgradesettingspayload) | | Yes |
|
|
| category | [TenantPluginAutoUpgradeCategory](#tenantpluginautoupgradecategory) | | Yes |
|
|
|
|
#### ParserAutoUpgradeFetch
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | [TenantPluginAutoUpgradeCategory](#tenantpluginautoupgradecategory) | | Yes |
|
|
|
|
#### ParserCreateCredential
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| name | string | | No |
|
|
|
|
#### ParserCredentialCreate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| name | string | | No |
|
|
|
|
#### ParserCredentialDelete
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
|
|
#### ParserCredentialId
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | No |
|
|
|
|
#### ParserCredentialSwitch
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
|
|
#### ParserCredentialUpdate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| credentials | object | | Yes |
|
|
| name | string | | No |
|
|
|
|
#### ParserCredentialValidate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
|
|
#### ParserDeleteCredential
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ParserDeleteModels
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ParserDynamicOptions
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string | | Yes |
|
|
| credential_id | string | | No |
|
|
| parameter | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| provider_type | string, <br>**Available values:** "tool", "trigger" | *Enum:* `"tool"`, `"trigger"` | Yes |
|
|
|
|
#### ParserDynamicOptionsWithCredentials
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string | | Yes |
|
|
| credential_id | string | | Yes |
|
|
| credentials | object | | Yes |
|
|
| parameter | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### ParserEnable
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enable_trigger | boolean | | Yes |
|
|
| trigger_id | string | | Yes |
|
|
|
|
#### ParserExcludePlugin
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | [TenantPluginAutoUpgradeCategory](#tenantpluginautoupgradecategory) | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
|
|
#### ParserGetCredentials
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config_from | string | | No |
|
|
| credential_id | string | | No |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ParserGetDefault
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ParserGithubInstall
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| package | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| repo | string | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### ParserGithubUpgrade
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_plugin_unique_identifier | string | | Yes |
|
|
| original_plugin_unique_identifier | string | | Yes |
|
|
| package | string | | Yes |
|
|
| repo | string | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### ParserGithubUpload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| package | string | | Yes |
|
|
| repo | string | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### ParserIcon
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| filename | string | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### ParserLatest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_ids | [ string ] | | Yes |
|
|
|
|
#### ParserList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| page_size | integer, <br>**Default:** 256 | Page size (1-256) | No |
|
|
|
|
#### ParserMarketplaceUpgrade
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_plugin_unique_identifier | string | | Yes |
|
|
| original_plugin_unique_identifier | string | | Yes |
|
|
|
|
#### ParserModelList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model_type | [ModelType](#modeltype) | | No |
|
|
|
|
#### ParserParameter
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
|
|
#### ParserPermissionChange
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| debug_permission | [TenantPluginDebugPermission](#tenantplugindebugpermission) | | No |
|
|
| install_permission | [TenantPluginInstallPermission](#tenantplugininstallpermission) | | No |
|
|
|
|
#### ParserPluginIdentifierQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
|
|
#### ParserPluginIdentifiers
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_unique_identifiers | [ string ] | | Yes |
|
|
|
|
#### ParserPostDefault
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model_settings | [ [Inner](#inner) ] | | Yes |
|
|
|
|
#### ParserPostModels
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config_from | string | | No |
|
|
| credential_id | string | | No |
|
|
| load_balancing | [LoadBalancingPayload](#loadbalancingpayload) | | No |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ParserPreferredProviderType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| preferred_provider_type | string, <br>**Available values:** "custom", "system" | *Enum:* `"custom"`, `"system"` | Yes |
|
|
|
|
#### ParserReadme
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Default:** en-US | | No |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
|
|
#### ParserSwitch
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ParserTasks
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| page_size | integer, <br>**Default:** 256 | Page size (1-256) | No |
|
|
|
|
#### ParserUninstall
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_installation_id | string | | Yes |
|
|
| preserve_credentials | boolean | | No |
|
|
|
|
#### ParserUpdateCredential
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_id | string | | Yes |
|
|
| credentials | object | | Yes |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
| name | string | | No |
|
|
|
|
#### ParserValidate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### PartialMemberListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ string ] | | Yes |
|
|
|
|
#### PasswordMismatchError
|
|
|
|
The passwords do not match.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PasswordMismatchError | | The passwords do not match. | |
|
|
|
|
#### PasswordResetRateLimitExceededError
|
|
|
|
Too many password reset emails have been sent. Please try again in {minutes} minutes.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PasswordResetRateLimitExceededError | | Too many password reset emails have been sent. Please try again in {minutes} minutes. | |
|
|
|
|
#### PausedNodeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_id | string | | Yes |
|
|
| node_title | string | | Yes |
|
|
| pause_type | [HumanInputPauseTypeResponse](#humaninputpausetyperesponse) | | Yes |
|
|
|
|
#### Permission
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| endpoint | [Endpoint](#endpoint) | | No |
|
|
| model | [Model](#model) | | No |
|
|
| node | [Node](#node) | | No |
|
|
| storage | [Storage](#storage) | | No |
|
|
| tool | [Tool](#tool) | | No |
|
|
|
|
#### PermissionCatalogGroup
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| group_key | string | | Yes |
|
|
| group_name | string | | Yes |
|
|
| permissions | [ [PermissionCatalogItem](#permissioncatalogitem) ] | | No |
|
|
|
|
#### PermissionCatalogItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| key | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### PermissionCatalogResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| groups | [ [PermissionCatalogGroup](#permissioncataloggroup) ] | | No |
|
|
|
|
#### PermissionEnum
|
|
|
|
Shared permission levels for resources (datasets, credentials, etc.)
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PermissionEnum | string | Shared permission levels for resources (datasets, credentials, etc.) | |
|
|
|
|
#### PipelineDataset
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chunk_structure | string | | Yes |
|
|
| description | string | knowledge dataset description | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### PipelineDocument
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data_source_info | object | | No |
|
|
| data_source_type | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| error | string | | No |
|
|
| id | string | | Yes |
|
|
| indexing_status | string | | Yes |
|
|
| name | string | | Yes |
|
|
| position | integer | | Yes |
|
|
|
|
#### PipelineGenerateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| batch | string | | Yes |
|
|
| dataset | [PipelineDataset](#pipelinedataset) | | Yes |
|
|
| documents | [ [PipelineDocument](#pipelinedocument) ] | | Yes |
|
|
|
|
#### PipelineNotFoundError
|
|
|
|
Pipeline not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PipelineNotFoundError | | Pipeline not found. | |
|
|
|
|
#### PipelineTemplateDetailQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Default:** built-in | Template source: built-in or customized | No |
|
|
|
|
#### PipelineTemplateDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chunk_structure | string | | Yes |
|
|
| created_by | string | | No |
|
|
| description | string | | Yes |
|
|
| export_data | string | | Yes |
|
|
| graph | object | | Yes |
|
|
| icon_info | object | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### PipelineTemplateItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chunk_structure | string | | Yes |
|
|
| copyright | string | | No |
|
|
| description | string | | Yes |
|
|
| icon | object | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| position | integer | | Yes |
|
|
| privacy_policy | string | | No |
|
|
|
|
#### PipelineTemplateListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Default:** en-US | Template language | No |
|
|
| type | string, <br>**Default:** built-in | Template source: built-in or customized | No |
|
|
|
|
#### PipelineTemplateListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| pipeline_templates | [ [PipelineTemplateItemResponse](#pipelinetemplateitemresponse) ] | | Yes |
|
|
|
|
#### PipelineVariableResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ string ] | | No |
|
|
| allowed_file_upload_methods | [ string ] | | No |
|
|
| belong_to_node_id | string | | Yes |
|
|
| default_value | | | No |
|
|
| label | string | | Yes |
|
|
| max_length | integer | | No |
|
|
| options | [ string ] | | No |
|
|
| placeholder | string | | No |
|
|
| required | boolean | | Yes |
|
|
| tooltips | string | | No |
|
|
| type | string | | Yes |
|
|
| unit | string | | No |
|
|
| variable | string | | Yes |
|
|
|
|
#### PlaintextSecretNotAllowedError
|
|
|
|
Plaintext secret values are not allowed in Agent config.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PlaintextSecretNotAllowedError | | Plaintext secret values are not allowed in Agent config. | |
|
|
|
|
#### PlanningStrategy
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PlanningStrategy | string | | |
|
|
|
|
#### PluginAutoUpgradeChangeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message | string | | No |
|
|
| success | boolean | | Yes |
|
|
|
|
#### PluginAutoUpgradeFetchResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_upgrade | [PluginAutoUpgradeSettingsResponseModel](#pluginautoupgradesettingsresponsemodel) | | Yes |
|
|
| category | [TenantPluginAutoUpgradeCategory](#tenantpluginautoupgradecategory) | | Yes |
|
|
|
|
#### PluginAutoUpgradeSettingsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| exclude_plugins | [ string ] | | No |
|
|
| include_plugins | [ string ] | | No |
|
|
| strategy_setting | [TenantPluginAutoUpgradeStrategySetting](#tenantpluginautoupgradestrategysetting) | | No |
|
|
| upgrade_mode | [TenantPluginAutoUpgradeMode](#tenantpluginautoupgrademode) | | No |
|
|
| upgrade_time_of_day | integer | | No |
|
|
|
|
#### PluginAutoUpgradeSettingsResponseModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| exclude_plugins | [ string ] | | Yes |
|
|
| include_plugins | [ string ] | | Yes |
|
|
| strategy_setting | [TenantPluginAutoUpgradeStrategySetting](#tenantpluginautoupgradestrategysetting) | | Yes |
|
|
| upgrade_mode | [TenantPluginAutoUpgradeMode](#tenantpluginautoupgrademode) | | Yes |
|
|
| upgrade_time_of_day | integer | | Yes |
|
|
|
|
#### PluginBundleDependency
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | [PluginBundleDependencyType](#pluginbundledependencytype) | | Yes |
|
|
| value | [PluginBundleDependencyGithub](#pluginbundledependencygithub)<br>[PluginBundleDependencyMarketplace](#pluginbundledependencymarketplace)<br>[PluginBundleDependencyPackage](#pluginbundledependencypackage) | | Yes |
|
|
|
|
#### PluginBundleDependencyGithub
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| packages | string | | Yes |
|
|
| release | string | | Yes |
|
|
| repo | string | | Yes |
|
|
| repo_address | string | | Yes |
|
|
|
|
#### PluginBundleDependencyMarketplace
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| organization | string | | Yes |
|
|
| plugin | string | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginBundleDependencyPackage
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| manifest | [PluginDeclaration](#plugindeclaration) | | Yes |
|
|
| unique_identifier | string | | Yes |
|
|
|
|
#### PluginBundleDependencyType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginBundleDependencyType | string | | |
|
|
|
|
#### PluginBundleUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginBundleUploadResponse | array | | |
|
|
|
|
#### PluginCategory
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginCategory | string | | |
|
|
|
|
#### PluginCategoryBuiltinToolProviderResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allow_delete | boolean | | Yes |
|
|
| author | string | | Yes |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| icon | string<br>object | | Yes |
|
|
| icon_dark | string<br>object | | Yes |
|
|
| id | string | | Yes |
|
|
| is_team_authorization | boolean | | Yes |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| labels | [ string ] | | Yes |
|
|
| name | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| team_credentials | object | | Yes |
|
|
| tools | [ [PluginCategoryBuiltinToolResponse](#plugincategorybuiltintoolresponse) ] | | Yes |
|
|
| type | [ToolProviderType](#toolprovidertype) | | Yes |
|
|
|
|
#### PluginCategoryBuiltinToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | | Yes |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| labels | [ string ] | | Yes |
|
|
| name | string | | Yes |
|
|
| output_schema | object | | Yes |
|
|
| parameters | [ object ] | | No |
|
|
|
|
#### PluginCategoryInstalledPluginResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checksum | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| declaration | [PluginDeclarationResponse](#plugindeclarationresponse) | | Yes |
|
|
| endpoints_active | integer | | Yes |
|
|
| endpoints_setups | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| installation_id | string | | Yes |
|
|
| meta | object | | Yes |
|
|
| name | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| runtime_type | string | | Yes |
|
|
| source | [PluginInstallationSource](#plugininstallationsource) | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginCategoryListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Available values:** "en_US", "ja_JP", "pt_BR", "zh_Hans", <br>**Default:** en_US | Language used for localized label and description search<br>*Enum:* `"en_US"`, `"ja_JP"`, `"pt_BR"`, `"zh_Hans"` | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
| page_size | integer, <br>**Default:** 256 | Page size (1-256) | No |
|
|
| query | string | Case-insensitive search query | No |
|
|
| tags | [ string ] | Match any plugin tag | No |
|
|
|
|
#### PluginCategoryListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| builtin_tools | [ [PluginCategoryBuiltinToolProviderResponse](#plugincategorybuiltintoolproviderresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| plugins | [ [PluginCategoryInstalledPluginResponse](#plugincategoryinstalledpluginresponse) ] | | Yes |
|
|
|
|
#### PluginDebuggingKeyResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| host | string | | Yes |
|
|
| key | string | | Yes |
|
|
| port | integer | | Yes |
|
|
|
|
#### PluginDeclaration
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_strategy | [AgentStrategyProviderEntity](#agentstrategyproviderentity) | | No |
|
|
| author | string | | Yes |
|
|
| category | [PluginCategory](#plugincategory) | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| datasource | [DatasourceProviderEntity](#datasourceproviderentity) | | No |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| endpoint | [EndpointProviderDeclaration](#endpointproviderdeclaration) | | No |
|
|
| icon | string | | Yes |
|
|
| icon_dark | string | | No |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| meta | [Meta](#meta) | | Yes |
|
|
| model | [ProviderEntity](#providerentity) | | No |
|
|
| name | string | | Yes |
|
|
| plugins | [Plugins](#plugins) | | Yes |
|
|
| repo | string | | No |
|
|
| resource | [PluginResourceRequirements](#pluginresourcerequirements) | | Yes |
|
|
| tags | [ string ] | | No |
|
|
| tool | [ToolProviderEntity](#toolproviderentity) | | No |
|
|
| trigger | [TriggerProviderEntity](#triggerproviderentity) | | No |
|
|
| verified | boolean | | No |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginDeclarationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_strategy | object | | No |
|
|
| author | string | | Yes |
|
|
| category | [PluginCategory](#plugincategory) | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| datasource | object | | No |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| endpoint | object | | No |
|
|
| icon | string | | Yes |
|
|
| icon_dark | string | | No |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| meta | object | | Yes |
|
|
| model | [ProviderEntityResponse](#providerentityresponse) | | No |
|
|
| name | string | | Yes |
|
|
| plugins | object | | Yes |
|
|
| repo | string | | No |
|
|
| resource | object | | Yes |
|
|
| tags | [ string ] | | No |
|
|
| tool | object | | No |
|
|
| trigger | object | | No |
|
|
| verified | boolean | | No |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginDecodeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| manifest | [PluginDeclaration](#plugindeclaration) | | Yes |
|
|
| unique_identifier | string | The unique identifier of the plugin. | Yes |
|
|
| verification | [PluginVerification](#pluginverification) | Basic verification information | No |
|
|
|
|
#### PluginDependency
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_identifier | string | | No |
|
|
| type | [PluginDependencyType](#plugindependencytype) | | Yes |
|
|
| value | [PluginDependencyGithub](#plugindependencygithub)<br>[PluginDependencyMarketplace](#plugindependencymarketplace)<br>[PluginDependencyPackage](#plugindependencypackage) | | Yes |
|
|
|
|
#### PluginDependencyGithub
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| github_plugin_unique_identifier | string | | Yes |
|
|
| package | string | | Yes |
|
|
| repo | string | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginDependencyMarketplace
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| marketplace_plugin_unique_identifier | string | | Yes |
|
|
| version | string | | No |
|
|
|
|
#### PluginDependencyPackage
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| version | string | | No |
|
|
|
|
#### PluginDependencyType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginDependencyType | string | | |
|
|
|
|
#### PluginDynamicOptionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| options | [ [PluginParameterOption](#pluginparameteroption) ] | | Yes |
|
|
|
|
#### PluginEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checksum | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| declaration | [PluginDeclaration](#plugindeclaration) | | Yes |
|
|
| endpoints_active | integer | | Yes |
|
|
| endpoints_setups | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| installation_id | string | | Yes |
|
|
| meta | object | | Yes |
|
|
| name | string | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| runtime_type | string | | Yes |
|
|
| source | [PluginInstallationSource](#plugininstallationsource) | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginError
|
|
|
|
Plugin operation failed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginError | | Plugin operation failed. | |
|
|
|
|
#### PluginInstallTask
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed_plugins | integer | The number of plugins that have been installed. | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| id | string | | Yes |
|
|
| plugins | [ [PluginInstallTaskPluginStatus](#plugininstalltaskpluginstatus) ] | The status of the plugins. | Yes |
|
|
| status | [PluginInstallTaskStatus](#plugininstalltaskstatus) | The status of the install task. | Yes |
|
|
| total_plugins | integer | The total number of plugins to be installed. | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
|
|
#### PluginInstallTaskPluginStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | The icon of the plugin. | Yes |
|
|
| labels | [I18nObject](#i18nobject) | The labels of the plugin. | Yes |
|
|
| message | string | The message of the install task. | Yes |
|
|
| plugin_id | string | The plugin ID of the install task. | Yes |
|
|
| plugin_unique_identifier | string | The plugin unique identifier of the install task. | Yes |
|
|
| source | string | The installation source of the plugin | No |
|
|
| status | [PluginInstallTaskStatus](#plugininstalltaskstatus) | The status of the install task. | Yes |
|
|
|
|
#### PluginInstallTaskStartResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| all_installed | boolean | Whether all plugins are installed. | Yes |
|
|
| task | [PluginInstallTask](#plugininstalltask) | The install task. | No |
|
|
| task_id | string | The ID of the install task. | Yes |
|
|
|
|
#### PluginInstallTaskStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginInstallTaskStatus | string | | |
|
|
|
|
#### PluginInstallationItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| checksum | string | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| declaration | [PluginDeclarationResponse](#plugindeclarationresponse) | | Yes |
|
|
| endpoints_active | integer | | Yes |
|
|
| endpoints_setups | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| meta | object | | Yes |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| runtime_type | string | | Yes |
|
|
| source | [PluginInstallationSource](#plugininstallationsource) | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| version | string | | Yes |
|
|
|
|
#### PluginInstallationPermissionModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_installation_scope | [PluginInstallationScope](#plugininstallationscope) | | Yes |
|
|
| restrict_to_marketplace_only | boolean | | Yes |
|
|
|
|
#### PluginInstallationScope
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginInstallationScope | string | | |
|
|
|
|
#### PluginInstallationSource
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginInstallationSource | string | | |
|
|
|
|
#### PluginInstallationsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugins | [ [PluginInstallationItemResponse](#plugininstallationitemresponse) ] | | Yes |
|
|
|
|
#### PluginInstalledIdsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | [PluginCategory](#plugincategory) | Plugin category to include | Yes |
|
|
|
|
#### PluginInstalledIdsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugin_ids | [ string ] | | Yes |
|
|
|
|
#### PluginListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| plugins | [ [PluginEntity](#pluginentity) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### PluginManifestResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| manifest | [PluginDeclaration](#plugindeclaration) | | Yes |
|
|
|
|
#### PluginOAuthAuthorizationUrlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authorization_url | string | The URL of the authorization. | Yes |
|
|
|
|
#### PluginOperationSuccessResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message | string | | No |
|
|
| success | boolean | | Yes |
|
|
|
|
#### PluginParameterAutoGenerate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | [PluginParameterAutoGenerateType](#pluginparameterautogeneratetype) | | Yes |
|
|
|
|
#### PluginParameterAutoGenerateType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PluginParameterAutoGenerateType | string | | |
|
|
|
|
#### PluginParameterOption
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | The icon of the option, can be a url or a base64 encoded image | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the option | Yes |
|
|
| value | string | The value of the option | Yes |
|
|
|
|
#### PluginParameterTemplate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | Whether the parameter is jinja enabled | No |
|
|
|
|
#### PluginPermissionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| debug_permission | [TenantPluginDebugPermission](#tenantplugindebugpermission) | | Yes |
|
|
| install_permission | [TenantPluginInstallPermission](#tenantplugininstallpermission) | | Yes |
|
|
|
|
#### PluginPermissionSettingsPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| debug_permission | [TenantPluginDebugPermission](#tenantplugindebugpermission) | | No |
|
|
| install_permission | [TenantPluginInstallPermission](#tenantplugininstallpermission) | | No |
|
|
|
|
#### PluginReadmeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| readme | string | | Yes |
|
|
|
|
#### PluginResourceRequirements
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| memory | integer | | Yes |
|
|
| permission | [Permission](#permission) | | No |
|
|
|
|
#### PluginTaskResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| task | [PluginInstallTask](#plugininstalltask) | | Yes |
|
|
|
|
#### PluginTasksResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tasks | [ [PluginInstallTask](#plugininstalltask) ] | | Yes |
|
|
|
|
#### PluginVerification
|
|
|
|
Verification of the plugin.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authorized_category | [AuthorizedCategory](#authorizedcategory) | The authorized category of the plugin. | Yes |
|
|
|
|
#### PluginVersionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| versions | object | | Yes |
|
|
|
|
#### Plugins
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasources | [ string ] | | No |
|
|
| endpoints | [ string ] | | No |
|
|
| models | [ string ] | | No |
|
|
| tools | [ string ] | | No |
|
|
| triggers | [ string ] | | No |
|
|
|
|
#### PreProcessingRule
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | Whether this preprocessing rule is enabled. | Yes |
|
|
| id | [PreProcessingRuleKey](#preprocessingrulekey) | Rule identifier. | Yes |
|
|
|
|
#### PreProcessingRuleKey
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PreProcessingRuleKey | string | | |
|
|
|
|
#### PreviewDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| child_chunks | [ string ] | | No |
|
|
| content | string | | Yes |
|
|
| summary | string | | No |
|
|
|
|
#### PriceConfig
|
|
|
|
Model class for pricing info.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| currency | string | | Yes |
|
|
| input | string | | Yes |
|
|
| output | string | | No |
|
|
| unit | string | | Yes |
|
|
|
|
#### PriceConfigResponse
|
|
|
|
Serialized pricing info with codegen-safe decimal string patterns.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| currency | string | | Yes |
|
|
| input | string | | Yes |
|
|
| output | string | | No |
|
|
| unit | string | | Yes |
|
|
|
|
#### ProcessRule
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mode | [ProcessRuleMode](#processrulemode) | `automatic` uses built-in rules, `custom` allows manual configuration, `hierarchical` enables parent-child chunk structure (use with `doc_form: hierarchical_model`). | Yes |
|
|
| rules | [Rule](#rule) | Custom processing rules. | No |
|
|
|
|
#### ProcessRuleLimitsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| indexing_max_segmentation_tokens_length | integer | | Yes |
|
|
|
|
#### ProcessRuleMode
|
|
|
|
Dataset Process Rule Mode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProcessRuleMode | string | Dataset Process Rule Mode | |
|
|
|
|
#### ProcessRuleResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limits | [ProcessRuleLimitsResponse](#processrulelimitsresponse) | | Yes |
|
|
| mode | [ProcessRuleMode](#processrulemode) | | Yes |
|
|
| rules | [Rule](#rule) | | No |
|
|
|
|
#### PromptTemplateMessageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| role | string, <br>**Available values:** "assistant", "system", "user" | *Enum:* `"assistant"`, `"system"`, `"user"` | Yes |
|
|
| text | string | | Yes |
|
|
|
|
#### PromptType
|
|
|
|
Prompt configuration type
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| PromptType | string | Prompt configuration type | |
|
|
|
|
#### ProviderConfig
|
|
|
|
Model class for common provider settings like credentials
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default | integer<br>string<br>number<br>boolean | | No |
|
|
| help | [I18nObject](#i18nobject) | | No |
|
|
| label | [I18nObject](#i18nobject) | | No |
|
|
| multiple | boolean | | No |
|
|
| name | string | The name of the credentials | Yes |
|
|
| options | [ [Option](#option) ] | | No |
|
|
| placeholder | [I18nObject](#i18nobject) | | No |
|
|
| required | boolean | | No |
|
|
| scope | [AppSelectorScope](#appselectorscope)<br>[ModelSelectorScope](#modelselectorscope)<br>[ToolSelectorScope](#toolselectorscope) | | No |
|
|
| type | [ProviderConfigType](#providerconfigtype) | The type of the credentials | Yes |
|
|
| url | string | | No |
|
|
|
|
#### ProviderConfigListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderConfigListResponse | array | | |
|
|
|
|
#### ProviderConfigType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderConfigType | string | | |
|
|
|
|
#### ProviderCredentialSchema
|
|
|
|
Model class for provider credential schema.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_form_schemas | [ [CredentialFormSchema](#credentialformschema) ] | | Yes |
|
|
|
|
#### ProviderCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | No |
|
|
|
|
#### ProviderEntity
|
|
|
|
Runtime-native provider schema.
|
|
|
|
`provider` is the canonical runtime identifier. `provider_name` is a
|
|
compatibility alias for callers that still resolve providers by short name and
|
|
is empty when no alias exists.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| background | string | | No |
|
|
| configurate_methods | [ [ConfigurateMethod](#configuratemethod) ] | | Yes |
|
|
| description | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| help | [ProviderHelpEntity](#providerhelpentity) | | No |
|
|
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| model_credential_schema | [ModelCredentialSchema](#modelcredentialschema) | | No |
|
|
| models | [ [AIModelEntity](#aimodelentity) ] | | No |
|
|
| position | object | | No |
|
|
| provider | string | | Yes |
|
|
| provider_credential_schema | [ProviderCredentialSchema](#providercredentialschema) | | No |
|
|
| provider_name | string | | No |
|
|
| supported_model_types | [ [ModelType](#modeltype) ] | | Yes |
|
|
|
|
#### ProviderEntityResponse
|
|
|
|
Runtime provider response with codegen-safe model pricing schemas.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| background | string | | No |
|
|
| configurate_methods | [ [ConfigurateMethod](#configuratemethod) ] | | Yes |
|
|
| description | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| help | [ProviderHelpEntity](#providerhelpentity) | | No |
|
|
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| model_credential_schema | [ModelCredentialSchema](#modelcredentialschema) | | No |
|
|
| models | [ [AIModelEntityResponse](#aimodelentityresponse) ], <br>**Default:** | | No |
|
|
| position | object | | No |
|
|
| provider | string | | Yes |
|
|
| provider_credential_schema | [ProviderCredentialSchema](#providercredentialschema) | | No |
|
|
| provider_name | string | | No |
|
|
| supported_model_types | [ [ModelType](#modeltype) ] | | Yes |
|
|
|
|
#### ProviderHelpEntity
|
|
|
|
Model class for provider help.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| title | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| url | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
|
|
#### ProviderModelListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ModelWithProviderEntityResponse](#modelwithproviderentityresponse) ] | | Yes |
|
|
|
|
#### ProviderModelWithStatusEntity
|
|
|
|
Model class for model response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deprecated | boolean | | No |
|
|
| features | [ [ModelFeature](#modelfeature) ] | | No |
|
|
| fetch_from | [FetchFrom](#fetchfrom) | Where the model definition comes from. `predefined-model` for built-in models, `customizable-model` for user-configured models. | Yes |
|
|
| has_invalid_load_balancing_configs | boolean | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | Localized display name of the model. | Yes |
|
|
| load_balancing_enabled | boolean | | No |
|
|
| model | string | | Yes |
|
|
| model_properties | object | | Yes |
|
|
| model_type | [ModelType](#modeltype) | Type of the model, matching the `model_type` path parameter. | Yes |
|
|
| status | [ModelStatus](#modelstatus) | Model availability status. `active` when ready to use. | Yes |
|
|
|
|
#### ProviderNotInitializeError
|
|
|
|
No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderNotInitializeError | | No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials. | |
|
|
|
|
#### ProviderNotSupportSpeechToTextError
|
|
|
|
Provider not support speech to text.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderNotSupportSpeechToTextError | | Provider not support speech to text. | |
|
|
|
|
#### ProviderNotSupportTextToSpeechError
|
|
|
|
Provider does not support text to speech.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderNotSupportTextToSpeechError | | Provider does not support text to speech. | |
|
|
|
|
#### ProviderQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| provider | string | | Yes |
|
|
|
|
#### ProviderQuotaExceededError
|
|
|
|
Your quota for Dify Hosted Model Provider has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderQuotaExceededError | | Your quota for Dify Hosted Model Provider has been exhausted. Please go to Settings -> Model Provider to complete your own provider credentials. | |
|
|
|
|
#### ProviderQuotaType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderQuotaType | string | | |
|
|
|
|
#### ProviderResponse
|
|
|
|
Model class for provider response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| background | string | | No |
|
|
| configurate_methods | [ [ConfigurateMethod](#configuratemethod) ] | | Yes |
|
|
| custom_configuration | [CustomConfigurationResponse](#customconfigurationresponse) | | Yes |
|
|
| description | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| help | [ProviderHelpEntity](#providerhelpentity) | | No |
|
|
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| model_credential_schema | [ModelCredentialSchema](#modelcredentialschema) | | No |
|
|
| preferred_provider_type | [ProviderType](#providertype) | | Yes |
|
|
| provider | string | | Yes |
|
|
| provider_credential_schema | [ProviderCredentialSchema](#providercredentialschema) | | No |
|
|
| supported_model_types | [ [ModelType](#modeltype) ] | | Yes |
|
|
| system_configuration | [SystemConfigurationResponse](#systemconfigurationresponse) | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### ProviderType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ProviderType | string | | |
|
|
|
|
#### ProviderWithModelsResponse
|
|
|
|
Model class for provider with models response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | Localized display name of the provider. | Yes |
|
|
| models | [ [ProviderModelWithStatusEntity](#providermodelwithstatusentity) ] | | Yes |
|
|
| provider | string | | Yes |
|
|
| status | [CustomConfigurationStatus](#customconfigurationstatus) | Provider status. `active` when credentials are configured and valid. | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### PublishWorkflowPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| marked_comment | string | | No |
|
|
| marked_name | string | | No |
|
|
|
|
#### PublishedWorkflowRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasource_info_list | [ object ] | | Yes |
|
|
| datasource_type | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
| is_preview | boolean | | No |
|
|
| original_document_id | string | | No |
|
|
| response_mode | string, <br>**Available values:** "blocking", "streaming", <br>**Default:** streaming | *Enum:* `"blocking"`, `"streaming"` | No |
|
|
| start_node_id | string | | Yes |
|
|
|
|
#### QAPreviewDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | Yes |
|
|
| question | string | | Yes |
|
|
|
|
#### QueryType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| QueryType | string | | |
|
|
|
|
#### Quota
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer | Quota limit; -1 means unlimited and 0 means no quota | Yes |
|
|
| reset_date | integer, <br>**Default:** -1 | Next quota reset as a Unix timestamp in seconds; -1 means no reset | Yes |
|
|
| usage | integer | | Yes |
|
|
|
|
#### QuotaConfiguration
|
|
|
|
Model class for provider quota configuration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| is_valid | boolean | | Yes |
|
|
| quota_limit | integer | | Yes |
|
|
| quota_type | [ProviderQuotaType](#providerquotatype) | | Yes |
|
|
| quota_unit | [QuotaUnit](#quotaunit) | | Yes |
|
|
| quota_used | integer | | Yes |
|
|
| restrict_models | [ [RestrictModel](#restrictmodel) ], <br>**Default:** | | No |
|
|
|
|
#### QuotaUnit
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| QuotaUnit | string | | |
|
|
|
|
#### RBACResourceType
|
|
|
|
Resource types understood by access policies.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RBACResourceType | string | Resource types understood by access policies. | |
|
|
|
|
#### RBACRole
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| category | string | | No |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| is_builtin | boolean | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| role_tag | string | | No |
|
|
| tenant_id | string | | No |
|
|
| type | string | | Yes |
|
|
|
|
#### RBACRoleAccount
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_id | string | | Yes |
|
|
| account_name | string | | No |
|
|
| avatar | string | | No |
|
|
| email | string | | No |
|
|
|
|
#### RagPipelineDatasetImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| yaml_content | string | | Yes |
|
|
|
|
#### RagPipelineDatasourceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RagPipelineDatasourceListResponse | array | | |
|
|
|
|
#### RagPipelineDatasourceProviderResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| declaration | [DatasourceProviderEntityWithPlugin](#datasourceproviderentitywithplugin) | | Yes |
|
|
| is_authorized | boolean | | No |
|
|
| plugin_id | string | | Yes |
|
|
| plugin_unique_identifier | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### RagPipelineDraftWorkflowRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| datasource_info_list | [ object ] | | Yes |
|
|
| datasource_type | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
| start_node_id | string | | Yes |
|
|
|
|
#### RagPipelineImportCheckDependenciesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] | | No |
|
|
|
|
#### RagPipelineImportPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| mode | string | | Yes |
|
|
| name | string | | No |
|
|
| pipeline_id | string | | No |
|
|
| yaml_content | string | | No |
|
|
| yaml_url | string | | No |
|
|
|
|
#### RagPipelineImportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_dsl_version | string | | Yes |
|
|
| dataset_id | string | | No |
|
|
| error | string | | No |
|
|
| id | string | | Yes |
|
|
| imported_dsl_version | string | | Yes |
|
|
| pipeline_id | string | | No |
|
|
| status | [ImportStatus](#importstatus) | | Yes |
|
|
|
|
#### RagPipelineOpaqueResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RagPipelineOpaqueResponse | | | |
|
|
|
|
#### RagPipelinePublishedRunResponse
|
|
|
|
Blocking run result: a preview run returns the workflow result, a processing run the queued batch.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RagPipelinePublishedRunResponse | [PipelineGenerateResponse](#pipelinegenerateresponse)<br>[WorkflowAppBlockingResponse](#workflowappblockingresponse) | Blocking run result: a preview run returns the workflow result, a processing run the queued batch. | |
|
|
|
|
#### RagPipelinePublishedWorkflowResponse
|
|
|
|
A null response means the pipeline has no published workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RagPipelinePublishedWorkflowResponse | [WorkflowResponse](#workflowresponse) | A null response means the pipeline has no published workflow. | |
|
|
|
|
#### RagPipelineRecommendedPluginQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Default:** all | | No |
|
|
|
|
#### RagPipelineRecommendedPluginsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| installed_recommended_plugins | [ [ToolProviderApiEntityResponse](#toolproviderapientityresponse) ] | | Yes |
|
|
| uninstalled_recommended_plugins | [ object ] | | Yes |
|
|
|
|
#### RagPipelineStepParametersResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| variables | [ [PipelineVariableResponse](#pipelinevariableresponse) ] | | Yes |
|
|
|
|
#### RagPipelineTransformResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| dataset_id | string | | Yes |
|
|
| pipeline_id | string | | Yes |
|
|
| status | string | | Yes |
|
|
|
|
#### RagPipelineWorkflowPublishResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### RagPipelineWorkflowRunQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_id | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
|
|
#### RagPipelineWorkflowSyncResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| hash | string | | Yes |
|
|
| result | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
|
|
#### RateLimitError
|
|
|
|
Rate Limit Error
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RateLimitError | | Rate Limit Error | |
|
|
|
|
#### RecentAppListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [RecentAppResponse](#recentappresponse) ] | | Yes |
|
|
|
|
#### RecentAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author_name | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [IconType](#icontype) | | No |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| maintainer | string | | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "agent-chat", "chat", "completion", "workflow" | *Enum:* `"advanced-chat"`, `"agent-chat"`, `"chat"`, `"completion"`, `"workflow"` | Yes |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| updated_at | integer | | Yes |
|
|
|
|
#### RecommendedAgentExportQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| format | string, <br>**Available values:** "ifpkg", "yaml", <br>**Default:** ifpkg | Export format; defaults to ifpkg<br>*Enum:* `"ifpkg"`, `"yaml"` | No |
|
|
| version_id | string (uuid) | Current published template snapshot ID | Yes |
|
|
|
|
#### RecommendedAppDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| can_trial | boolean | | Yes |
|
|
| export_data | string | | Yes |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| id | string | | Yes |
|
|
| mode | string | | Yes |
|
|
| name | string | | Yes |
|
|
| package_url | string | Download URL for a New Agent .ifpkg template | No |
|
|
| version_id | string | Published version for direct local template creation | No |
|
|
|
|
#### RecommendedAppInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| icon_url | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mode | string | | No |
|
|
| name | string | | No |
|
|
|
|
#### RecommendedAppListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| categories | [ string ] | | Yes |
|
|
| recommended_apps | [ [RecommendedAppResponse](#recommendedappresponse) ] | | Yes |
|
|
|
|
#### RecommendedAppNotFoundError
|
|
|
|
Recommended app not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RecommendedAppNotFoundError | | Recommended app not found. | |
|
|
|
|
#### RecommendedAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app | [RecommendedAppInfoResponse](#recommendedappinforesponse) | | No |
|
|
| app_id | string | | Yes |
|
|
| can_trial | boolean | | Yes |
|
|
| categories | [ string ] | | No |
|
|
| copyright | string | | No |
|
|
| custom_disclaimer | string | | No |
|
|
| description | string | | No |
|
|
| is_listed | boolean | | No |
|
|
| position | integer | | No |
|
|
| privacy_policy | string | | No |
|
|
|
|
#### RecommendedAppsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Default:** en-US | Language code for recommended app localization | No |
|
|
|
|
#### RecursiveJSONValue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RecursiveJSONValue | string<br>integer<br>number<br>boolean<br>object<br>[ [RecursiveJSONValue](#recursivejsonvalue) ] | | |
|
|
|
|
#### Redacted
|
|
|
|
A configured credential whose stored value is omitted.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Default:** redacted | | No |
|
|
|
|
#### RedirectResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RedirectResponse | string | | |
|
|
|
|
#### RedirectUrlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| redirect_url | string | | Yes |
|
|
|
|
#### RelatedAppListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [RelatedAppResponse](#relatedappresponse) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### RelatedAppResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| icon | string | | Yes |
|
|
| icon_background | string | | Yes |
|
|
| icon_type | [IconType](#icontype) | | Yes |
|
|
| icon_url | string | | No |
|
|
| id | string | | Yes |
|
|
| mode | [AppMode](#appmode) | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### RemoteFileAccessDeniedError
|
|
|
|
The remote file cannot be accessed without authorization.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RemoteFileAccessDeniedError | | The remote file cannot be accessed without authorization. | |
|
|
|
|
#### RemoteFileInfo
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_length | integer | | Yes |
|
|
| file_type | string | | Yes |
|
|
|
|
#### RemoteFileInvalidResponseError
|
|
|
|
The remote file server returned an invalid response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RemoteFileInvalidResponseError | | The remote file server returned an invalid response. | |
|
|
|
|
#### RemoteFileInvalidUrlError
|
|
|
|
The remote file URL is invalid.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RemoteFileInvalidUrlError | | The remote file URL is invalid. | |
|
|
|
|
#### RemoteFileNotFoundError
|
|
|
|
The remote file could not be found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RemoteFileNotFoundError | | The remote file could not be found. | |
|
|
|
|
#### RemoteFileUnavailableError
|
|
|
|
The remote file is temporarily unavailable.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RemoteFileUnavailableError | | The remote file is temporarily unavailable. | |
|
|
|
|
#### RemoteFileUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string (uri) | URL to fetch | Yes |
|
|
|
|
#### RemoteFileUrlBlockedError
|
|
|
|
The remote file URL is not allowed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RemoteFileUrlBlockedError | | The remote file URL is not allowed. | |
|
|
|
|
#### RemoveContactsRequest
|
|
|
|
Request body for batch-removing platform or external contacts.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact_ids | [ string ] | Contact identifiers selected for removal from the contact directory surface. | Yes |
|
|
|
|
#### RemoveContactsResponse
|
|
|
|
Response body returned after batch-removing contacts.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| removed_contact_ids | [ string ] | Contact identifiers removed by the current operation. | Yes |
|
|
|
|
#### ReplaceUserAccessPolicies
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_policy_ids | [ string ] | | No |
|
|
| account_ids | [ string ] | | No |
|
|
|
|
#### ReplaceUserAccessPoliciesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_policies | [ [AccessPolicy](#accesspolicy) ] | | No |
|
|
|
|
#### RequestLog
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | dateTime | The created at of the request log | Yes |
|
|
| endpoint | string | The endpoint of the request log | Yes |
|
|
| id | string | The id of the request log | Yes |
|
|
| request | object | The request of the request log | Yes |
|
|
| response | object | The response of the request log | Yes |
|
|
|
|
#### RerankMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RerankMode | string | | |
|
|
|
|
#### RerankingModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| reranking_model_name | string | Name of the reranking model. | No |
|
|
| reranking_provider_name | string | Provider name of the reranking model. | No |
|
|
|
|
#### ResendCredentials
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_key | [_RequiredSecret](#_requiredsecret) | Resend API key. | Yes |
|
|
| provider | string | | No |
|
|
|
|
#### ResendCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_key | [Redacted](#redacted) | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### ResendCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| api_key | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### ResetContactIMOverrideResponse
|
|
|
|
Response body returned after resetting one contact IM override.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContact](#humaninputcontact) | Contact snapshot after the override is cleared. | Yes |
|
|
|
|
#### ResolvedForm
|
|
|
|
Immutable authoritative presentation snapshot for one v2 form.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| actions | [ [UserAction](#useraction) ] | | Yes |
|
|
| legacy_form_content | string | | Yes |
|
|
| parts | [ [FormPart](#formpart) ] | | Yes |
|
|
| title | string | | Yes |
|
|
|
|
#### ResourceAccessTokenCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| resources | [ [ResourceAccessTokenResourcePayload](#resourceaccesstokenresourcepayload) ] | | Yes |
|
|
|
|
#### ResourceAccessTokenCreateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ResourceAccessTokenRowResponse](#resourceaccesstokenrowresponse) ] | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### ResourceAccessTokenListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### ResourceAccessTokenListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ResourceAccessTokenRowResponse](#resourceaccesstokenrowresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### ResourceAccessTokenResourcePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| type | [ResourceAccessTokenResourceType](#resourceaccesstokenresourcetype) | | Yes |
|
|
|
|
#### ResourceAccessTokenResourceType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ResourceAccessTokenResourceType | string | | |
|
|
|
|
#### ResourceAccessTokenRowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| last_used_at | integer | | No |
|
|
| masked_token | string | | Yes |
|
|
| name | string | | Yes |
|
|
| relation_id | string | | Yes |
|
|
| resource_id | string | | Yes |
|
|
| resource_name | string | | Yes |
|
|
| resource_type | [ResourceAccessTokenResourceType](#resourceaccesstokenresourcetype) | | Yes |
|
|
| token | string | | No |
|
|
| token_id | string | | Yes |
|
|
| track_id | string | | Yes |
|
|
|
|
#### ResourceAccessTokenUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
| resources | [ [ResourceAccessTokenResourcePayload](#resourceaccesstokenresourcepayload) ] | | Yes |
|
|
|
|
#### ResourcePermissionKeys
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| permission_keys | [ string ] | | No |
|
|
| resource_id | string | | Yes |
|
|
|
|
#### ResourcePermissionSnapshot
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_permission_keys | [ string ] | | No |
|
|
| overrides | [ [ResourcePermissionKeys](#resourcepermissionkeys) ] | | No |
|
|
|
|
#### ResourceUserAccessPolicies
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_policies | [ [AccessPolicy](#accesspolicy) ] | | No |
|
|
| account | [RBACRoleAccount](#rbacroleaccount) | | Yes |
|
|
| roles | [ [RBACRole](#rbacrole) ] | | No |
|
|
|
|
#### ResourceUserAccessPoliciesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [ResourceUserAccessPolicies](#resourceuseraccesspolicies) ] | | No |
|
|
| pagination | [Pagination](#pagination) | | No |
|
|
|
|
#### ResourceWhitelist
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_ids | [ string ] | | No |
|
|
|
|
#### ResourceWhitelistConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| automatic_include_workspace_members | boolean | | Yes |
|
|
|
|
#### RestrictModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| base_model_name | string | | No |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### ResultResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | | Yes |
|
|
|
|
#### RetrievalMethod
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RetrievalMethod | string | | |
|
|
|
|
#### RetrievalModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| metadata_filtering_conditions | [MetadataFilteringCondition](#metadatafilteringcondition) | Restrict retrieval to chunks whose document metadata matches the given conditions. Conditions are evaluated server-side against document metadata fields. | No |
|
|
| reranking_enable | boolean | Whether reranking is enabled. | Yes |
|
|
| reranking_mode | string, <br>**Available values:** "reranking_model", "weighted_score" | Reranking mode. Required when `reranking_enable` is `true`. | No |
|
|
| reranking_model | [RerankingModel](#rerankingmodel) | Reranking model configuration. | No |
|
|
| score_threshold | number | Minimum similarity score for results. Only effective when score threshold filtering is enabled. | No |
|
|
| score_threshold_enabled | boolean | Whether score threshold filtering is enabled. | Yes |
|
|
| search_method | [RetrievalMethod](#retrievalmethod) | Search method used for retrieval. | Yes |
|
|
| top_k | integer | Maximum number of results to return. | Yes |
|
|
| weights | [WeightModel](#weightmodel) | Weight configuration for hybrid search. | No |
|
|
|
|
#### RetrievalSettingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| retrieval_method | [ string ] | | Yes |
|
|
|
|
#### RetrievalSourceMetadata
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| data_source_type | string | | No |
|
|
| dataset_id | string | | No |
|
|
| dataset_name | string | | No |
|
|
| doc_metadata | object | | No |
|
|
| document_asset_id | string | | No |
|
|
| document_id | string | | No |
|
|
| document_name | string | | No |
|
|
| document_revision | integer | | No |
|
|
| document_version | integer | | No |
|
|
| files | [ object ] | | No |
|
|
| hit_count | integer | | No |
|
|
| index_node_hash | string | | No |
|
|
| knowledge_fs_citation | [KnowledgeFsCitation](#knowledgefscitation) | | No |
|
|
| page | integer | | No |
|
|
| position | integer | | No |
|
|
| retriever_from | string | | No |
|
|
| score | number | | No |
|
|
| segment_id | string | | No |
|
|
| segment_position | integer | | No |
|
|
| summary | string | | No |
|
|
| title | string | | No |
|
|
| word_count | integer | | No |
|
|
|
|
#### RetrieverResource
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| created_at | integer | | No |
|
|
| data_source_type | string | | No |
|
|
| dataset_id | string | | No |
|
|
| dataset_name | string | | No |
|
|
| doc_metadata | object | | No |
|
|
| document_asset_id | string | | No |
|
|
| document_id | string | | No |
|
|
| document_name | string | | No |
|
|
| document_revision | integer | | No |
|
|
| document_version | integer | | No |
|
|
| files | [ object ] | | No |
|
|
| hit_count | integer | | No |
|
|
| id | string (uuid) | | No |
|
|
| index_node_hash | string | | No |
|
|
| knowledge_fs_citation | [KnowledgeFsCitation](#knowledgefscitation) | | No |
|
|
| message_id | string (uuid) | | No |
|
|
| page | integer | | No |
|
|
| position | integer | | Yes |
|
|
| retriever_from | string | | No |
|
|
| score | number | | No |
|
|
| segment_id | string | | No |
|
|
| segment_position | integer | | No |
|
|
| summary | string | | No |
|
|
| title | string | | No |
|
|
| word_count | integer | | No |
|
|
|
|
#### RetryConfig
|
|
|
|
node retry config
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| max_retries | integer | | No |
|
|
| retry_enabled | boolean | | No |
|
|
| retry_interval | integer | | No |
|
|
|
|
#### RoleAlreadyAssignedError
|
|
|
|
Role already assigned.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RoleAlreadyAssignedError | | Role already assigned. | |
|
|
|
|
#### RoleBindingsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AccessPolicyRoleBinding](#accesspolicyrolebinding) ] | | No |
|
|
|
|
#### RosterAgentPackageExportFailedError
|
|
|
|
The Roster Agent package could not be exported.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RosterAgentPackageExportFailedError | | The Roster Agent package could not be exported. | |
|
|
|
|
#### RosterAgentPackageImportFailedError
|
|
|
|
The Roster Agent package could not be imported.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RosterAgentPackageImportFailedError | | The Roster Agent package could not be imported. | |
|
|
|
|
#### RosterAgentPackageResourceUnavailableError
|
|
|
|
The Roster Agent package resources could not be stored.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RosterAgentPackageResourceUnavailableError | | The Roster Agent package resources could not be stored. | |
|
|
|
|
#### RosterAgentPackageTooLargeError
|
|
|
|
The Roster Agent package exceeds the size limit.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| RosterAgentPackageTooLargeError | | The Roster Agent package exceeds the size limit. | |
|
|
|
|
#### RosterListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### Rule
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| parent_mode | string, <br>**Available values:** "full-doc", "paragraph" | Parent-child segmentation mode. | No |
|
|
| pre_processing_rules | [ [PreProcessingRule](#preprocessingrule) ] | Pre-processing rules to apply before segmentation. | No |
|
|
| segmentation | [Segmentation](#segmentation) | Parent chunk segmentation settings. | No |
|
|
| subchunk_segmentation | [Segmentation](#segmentation) | Child chunk segmentation settings. | No |
|
|
|
|
#### RuleCodeGeneratePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code_language | string, <br>**Default:** javascript | Programming language for code generation | No |
|
|
| instruction | string | Rule generation instruction | Yes |
|
|
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
|
|
| no_variable | boolean | Whether to exclude variables | No |
|
|
|
|
#### RuleGeneratePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| instruction | string | Rule generation instruction | Yes |
|
|
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
|
|
| no_variable | boolean | Whether to exclude variables | No |
|
|
|
|
#### RuleGenerateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | Yes |
|
|
| opening_statement | string | | Yes |
|
|
| prompt | string | | Yes |
|
|
| variables | [ string ] | | Yes |
|
|
|
|
#### RuleStructuredOutputPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| instruction | string | Structured output generation instruction | Yes |
|
|
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
|
|
|
|
#### SSOProtocol
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SSOProtocol | string | | |
|
|
|
|
#### SandboxDownloadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string | | Yes |
|
|
|
|
#### SandboxFileEntryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mtime | integer | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
| type | string, <br>**Available values:** "dir", "file", "other", "symlink" | *Enum:* `"dir"`, `"file"`, `"other"`, `"symlink"` | Yes |
|
|
|
|
#### SandboxInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| workspace_cwd | string | | Yes |
|
|
|
|
#### SandboxListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| entries | [ [SandboxFileEntryResponse](#sandboxfileentryresponse) ] | | No |
|
|
| path | string | | Yes |
|
|
| truncated | boolean | | No |
|
|
|
|
#### SandboxReadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binary | boolean | | Yes |
|
|
| path | string | | Yes |
|
|
| size | integer | | No |
|
|
| text | string | | No |
|
|
| truncated | boolean | | Yes |
|
|
|
|
#### SavedMessageCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message_id | string | | Yes |
|
|
|
|
#### SavedMessageInfiniteScrollPagination
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SavedMessageItem](#savedmessageitem) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
|
|
#### SavedMessageItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| feedback | [SimpleFeedback](#simplefeedback) | | No |
|
|
| id | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
| message_files | [ [MessageFile](#messagefile) ] | | Yes |
|
|
| query | string | | Yes |
|
|
|
|
#### SavedMessageListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_id | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
|
|
#### SchemaDefinitionItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | string | | Yes |
|
|
| name | string | | Yes |
|
|
| schema | object | | Yes |
|
|
|
|
#### SchemaDefinitionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SchemaDefinitionsResponse | array | | |
|
|
|
|
#### SegmentAttachmentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| extension | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| name | string | | Yes |
|
|
| size | integer | | Yes |
|
|
| source_url | string | | Yes |
|
|
|
|
#### SegmentBatchImportStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| job_id | string | | Yes |
|
|
| job_status | string | | Yes |
|
|
|
|
#### SegmentCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | No |
|
|
| attachment_ids | [ string ] | | No |
|
|
| content | string | | Yes |
|
|
| keywords | [ string ] | | No |
|
|
|
|
#### SegmentDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [SegmentResponse](#segmentresponse) | | Yes |
|
|
| doc_form | string | | Yes |
|
|
|
|
#### SegmentIdListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| segment_id | [ string ] | Segment IDs | No |
|
|
|
|
#### SegmentListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | string, <br>**Default:** all | | No |
|
|
| hit_count_gte | integer | | No |
|
|
| keyword | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
| status | [ string ] | | No |
|
|
|
|
#### SegmentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | Yes |
|
|
| attachments | [ [SegmentAttachmentResponse](#segmentattachmentresponse) ] | | Yes |
|
|
| child_chunks | [ [ChildChunkResponse](#childchunkresponse) ] | | Yes |
|
|
| completed_at | integer | | Yes |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| disabled_at | integer | | Yes |
|
|
| disabled_by | string | | Yes |
|
|
| document_id | string | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| error | string | | Yes |
|
|
| hit_count | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| index_node_hash | string | | Yes |
|
|
| index_node_id | string | | Yes |
|
|
| indexing_at | integer | | Yes |
|
|
| keywords | [ string ] | | Yes |
|
|
| position | integer | | Yes |
|
|
| sign_content | string | | Yes |
|
|
| status | string, <br>**Available values:** "completed", "error", "indexing", "paused", "re_segment", "waiting" | *Enum:* `"completed"`, `"error"`, `"indexing"`, `"paused"`, `"re_segment"`, `"waiting"` | Yes |
|
|
| stopped_at | integer | | Yes |
|
|
| summary | string | | Yes |
|
|
| tokens | integer | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| word_count | integer | | Yes |
|
|
|
|
#### SegmentUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | No |
|
|
| attachment_ids | [ string ] | | No |
|
|
| content | string | | Yes |
|
|
| keywords | [ string ] | | No |
|
|
| regenerate_child_chunks | boolean | | No |
|
|
| summary | string | | No |
|
|
|
|
#### Segmentation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chunk_overlap | integer | Token overlap between chunks. | No |
|
|
| max_tokens | integer | Maximum token count per chunk. | Yes |
|
|
| separator | string, <br>**Default:**
|
|
| Custom separator for splitting text. | No |
|
|
|
|
#### SelectInput
|
|
|
|
Resolved single-choice input with immutable concrete options.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| default_value | string | | Yes |
|
|
| options | [ string ] | | Yes |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### SelectInputConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| option_source | [StringListSource](#stringlistsource) | Source of options for `select` inputs. Present only when `type` is `select`. | Yes |
|
|
| output_variable_name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### SetContactIMOverrideRequest
|
|
|
|
Request body for setting one workspace-scoped IM override.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| identity_id | string | Synced IM identity identifier selected as the workspace override. | Yes |
|
|
|
|
#### SetContactIMOverrideResponse
|
|
|
|
Response body returned after setting one contact IM override.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| contact | [HumanInputContact](#humaninputcontact) | Contact snapshot after the override is applied. | Yes |
|
|
|
|
#### ShallowJSONValue
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ShallowJSONValue | string<br>integer<br>number<br>boolean<br>object<br>[ object ] | | |
|
|
|
|
#### SimpleAccount
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### SimpleAccountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### SimpleConversation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| id | string (uuid) | | Yes |
|
|
| inputs | object | | Yes |
|
|
| introduction | string | | No |
|
|
| name | string | | Yes |
|
|
| status | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
|
|
#### SimpleDataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | string | | Yes |
|
|
|
|
#### SimpleEndUser
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| is_anonymous | boolean | | Yes |
|
|
| session_id | string | | No |
|
|
| type | string | | Yes |
|
|
|
|
#### SimpleFeedback
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| rating | string | | No |
|
|
|
|
#### SimpleMessageDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| answer | string | | Yes |
|
|
| inputs | object | | Yes |
|
|
| message | string | | Yes |
|
|
| query | string | | Yes |
|
|
|
|
#### SimpleModelConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | [AnyJSONValue](#anyjsonvalue) | | No |
|
|
| pre_prompt | string | | No |
|
|
|
|
#### SimpleProviderEntityResponse
|
|
|
|
Simple provider entity response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon_small | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| icon_small_dark | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | No |
|
|
| label | [ModelRuntimeI18nObject](#modelruntimei18nobject) | | Yes |
|
|
| models | [ [AIModelEntityResponse](#aimodelentityresponse) ], <br>**Default:** | | No |
|
|
| provider | string | | Yes |
|
|
| provider_name | string | | No |
|
|
| supported_model_types | [ [ModelType](#modeltype) ] | | Yes |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### SimpleResultDataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | string | | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### SimpleResultMessageResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message | string | | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### SimpleResultOptionalDataResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | string | | No |
|
|
| result | string | | Yes |
|
|
|
|
#### SimpleResultResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Operation result. | Yes |
|
|
|
|
#### Site
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| chat_color_theme | string | | No |
|
|
| chat_color_theme_inverted | boolean | | Yes |
|
|
| copyright | string | | No |
|
|
| custom_disclaimer | string | | No |
|
|
| default_language | string | | Yes |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | string | | No |
|
|
| icon_url | string | | Yes |
|
|
| input_placeholder | string | | No |
|
|
| privacy_policy | string | | No |
|
|
| show_workflow_steps | boolean | | Yes |
|
|
| title | string | | Yes |
|
|
| use_icon_as_answer_icon | boolean | | Yes |
|
|
|
|
#### SkillAssistAttachmentPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mime_type | string | | No |
|
|
| name | string | | Yes |
|
|
| size | integer | | No |
|
|
| tool_file_id | string | | Yes |
|
|
|
|
#### SkillAssistHistoryMessagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| role | string, <br>**Available values:** "assistant", "user" | *Enum:* `"assistant"`, `"user"` | Yes |
|
|
| suggested_display_name | string | | No |
|
|
| suggested_name | string | | No |
|
|
|
|
#### SkillAssistMessagePayload
|
|
|
|
One user message and optional uploaded context for the Skill Authoring assistant.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| attachments | [ [SkillAssistAttachmentPayload](#skillassistattachmentpayload) ] | | No |
|
|
| history | [ [SkillAssistHistoryMessagePayload](#skillassisthistorymessagepayload) ] | | No |
|
|
| message | string | | Yes |
|
|
| model | [SkillAssistModelPayload](#skillassistmodelpayload) | | No |
|
|
| target_path | string | | No |
|
|
|
|
#### SkillAssistModelPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| model_settings | object | | No |
|
|
| plugin_id | string | | No |
|
|
| provider | string | | Yes |
|
|
|
|
#### SkillCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| display_name | string | | No |
|
|
| icon | string, <br>**Default:** 📄 | | No |
|
|
| name | string | | No |
|
|
| tags | [ string ] | | No |
|
|
|
|
#### SkillDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| confirmation_name | string | Required when deleting a referenced Skill. Must match the Skill display name. | No |
|
|
|
|
#### SkillDeleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deleted | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
|
|
#### SkillDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | No |
|
|
| created_by_name | string | | No |
|
|
| description | string | | Yes |
|
|
| display_name | string | | Yes |
|
|
| files | [ [SkillFileResponse](#skillfileresponse) ] | | No |
|
|
| icon | string | | Yes |
|
|
| id | string | | Yes |
|
|
| latest_published_at | integer | | No |
|
|
| latest_published_version_id | string | | No |
|
|
| latest_published_version_number | integer | | No |
|
|
| name | string | | Yes |
|
|
| name_manually_edited | boolean | | No |
|
|
| reference_count | integer | | No |
|
|
| tags | [ string ] | | No |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | No |
|
|
| updated_by_name | string | | No |
|
|
| visibility | string | | Yes |
|
|
|
|
#### SkillDraftFileCheckItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| filename | string | | Yes |
|
|
| mime_type | string | | No |
|
|
| path | string | Target draft path. Defaults to filename. | No |
|
|
| size | integer | | Yes |
|
|
|
|
#### SkillDraftFileCheckPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ [SkillDraftFileCheckItemPayload](#skilldraftfilecheckitempayload) ] | | No |
|
|
|
|
#### SkillDraftFileOperation
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SkillDraftFileOperation | string | | |
|
|
|
|
#### SkillDraftFileOperationPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| expected_updated_at | integer | | No |
|
|
| hash | string | | No |
|
|
| mime_type | string | | No |
|
|
| operation | [SkillDraftFileOperation](#skilldraftfileoperation) | | Yes |
|
|
| path | string | | Yes |
|
|
| size | integer | | No |
|
|
| target_path | string | | No |
|
|
| tool_file_id | string | | No |
|
|
|
|
#### SkillDraftTreeItemPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| hash | string | | No |
|
|
| kind | [SkillFileKind](#skillfilekind) | | No |
|
|
| mime_type | string | | No |
|
|
| path | string | | Yes |
|
|
| size | integer | | No |
|
|
| storage | [SkillFileStorage](#skillfilestorage) | | No |
|
|
| tool_file_id | string | | No |
|
|
|
|
#### SkillDraftTreePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| expected_updated_at | integer | | No |
|
|
| files | [ [SkillDraftTreeItemPayload](#skilldrafttreeitempayload) ] | | No |
|
|
|
|
#### SkillFileCheckErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | string | | Yes |
|
|
| message | string | | Yes |
|
|
|
|
#### SkillFileCheckItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| errors | [ [SkillFileCheckErrorResponse](#skillfilecheckerrorresponse) ] | | No |
|
|
| extension | string | | Yes |
|
|
| filename | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| path | string | | Yes |
|
|
| size | integer | | Yes |
|
|
|
|
#### SkillFileCheckResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | object | | No |
|
|
|
|
#### SkillFileKind
|
|
|
|
Draft file entry kind.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SkillFileKind | string | Draft file entry kind. | |
|
|
|
|
#### SkillFilePreviewResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| hash | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| path | string | | Yes |
|
|
| size | integer | | Yes |
|
|
|
|
#### SkillFileQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| path | string | Skill file path relative to the Skill root. | Yes |
|
|
| version_id | string | Optional published version ID. Omit for current draft. | No |
|
|
|
|
#### SkillFileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | No |
|
|
| hash | string | | No |
|
|
| id | string | | No |
|
|
| kind | string | | Yes |
|
|
| mime_type | string | | No |
|
|
| path | string | | Yes |
|
|
| size | integer | | No |
|
|
| storage | string | | No |
|
|
| tool_file_id | string | | No |
|
|
|
|
#### SkillFileStorage
|
|
|
|
How a draft file's content is stored.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SkillFileStorage | string | How a draft file's content is stored. | |
|
|
|
|
#### SkillFileUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| hash | string | | Yes |
|
|
| id | string | | Yes |
|
|
| mime_type | string | | Yes |
|
|
| name | string | | Yes |
|
|
| size | integer | | Yes |
|
|
|
|
#### SkillListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SkillResponse](#skillresponse) ] | | No |
|
|
| has_more | boolean | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
| total | integer | | No |
|
|
|
|
#### SkillMetadataPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| display_name | string | | No |
|
|
| expected_updated_at | integer | | No |
|
|
| icon | string | | No |
|
|
| tags | [ string ] | | No |
|
|
|
|
#### SkillPublishPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| publish_note | string | | No |
|
|
| version_name | string | | No |
|
|
|
|
#### SkillReferenceListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SkillReferenceResponse](#skillreferenceresponse) ] | | No |
|
|
|
|
#### SkillReferenceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_icon | string | | No |
|
|
| agent_icon_background | string | | No |
|
|
| agent_icon_type | string | | No |
|
|
| agent_id | string | | Yes |
|
|
| app_id | string | | No |
|
|
| display_name | string | | Yes |
|
|
| name | string | | Yes |
|
|
| node_id | string | | No |
|
|
| node_name | string | | No |
|
|
| type | string | | Yes |
|
|
| workflow_icon | string | | No |
|
|
| workflow_icon_background | string | | No |
|
|
| workflow_icon_type | string | | No |
|
|
| workflow_id | string | | No |
|
|
| workflow_name | string | | No |
|
|
| workflow_version | string | | No |
|
|
|
|
#### SkillResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | No |
|
|
| created_by_name | string | | No |
|
|
| description | string | | Yes |
|
|
| display_name | string | | Yes |
|
|
| icon | string | | Yes |
|
|
| id | string | | Yes |
|
|
| latest_published_at | integer | | No |
|
|
| latest_published_version_id | string | | No |
|
|
| latest_published_version_number | integer | | No |
|
|
| name | string | | Yes |
|
|
| name_manually_edited | boolean | | No |
|
|
| reference_count | integer | | No |
|
|
| tags | [ string ] | | No |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | No |
|
|
| updated_by_name | string | | No |
|
|
| visibility | string | | Yes |
|
|
|
|
#### SkillRestorePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| publish_note | string | | No |
|
|
| version_id | string | | Yes |
|
|
| version_name | string | | No |
|
|
|
|
#### SkillTagListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SkillTagResponse](#skilltagresponse) ] | | No |
|
|
|
|
#### SkillTagResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer | | Yes |
|
|
| tag | string | | Yes |
|
|
|
|
#### SkillVersionDeleteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deleted | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| latest_published_version_id | string | | No |
|
|
|
|
#### SkillVersionDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archive_size | integer | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| files | [ [SkillFileResponse](#skillfileresponse) ] | | No |
|
|
| hash_code | string | | Yes |
|
|
| id | string | | Yes |
|
|
| is_latest | boolean | | No |
|
|
| publish_note | string | | Yes |
|
|
| published_by | string | | No |
|
|
| published_by_name | string | | No |
|
|
| skill_id | string | | Yes |
|
|
| version_name | string | | Yes |
|
|
| version_number | integer | | Yes |
|
|
|
|
#### SkillVersionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SkillVersionResponse](#skillversionresponse) ] | | No |
|
|
|
|
#### SkillVersionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archive_size | integer | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| hash_code | string | | Yes |
|
|
| id | string | | Yes |
|
|
| is_latest | boolean | | No |
|
|
| publish_note | string | | Yes |
|
|
| published_by | string | | No |
|
|
| published_by_name | string | | No |
|
|
| skill_id | string | | Yes |
|
|
| version_name | string | | Yes |
|
|
| version_number | integer | | Yes |
|
|
|
|
#### SkillVersionUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| publish_note | string | | No |
|
|
| version_name | string | | No |
|
|
|
|
#### SlackCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_token | [_OptionalSecret](#_optionalsecret) | Optional Slack app-level token required only for Socket Mode. | No |
|
|
| bot_token | [_RequiredSecret](#_requiredsecret) | Slack bot API token. | Yes |
|
|
| client_id | string | Slack OAuth client identifier. | Yes |
|
|
| client_secret | [_RequiredSecret](#_requiredsecret) | Slack OAuth client secret. | Yes |
|
|
| provider | string | Slack credential discriminator. | Yes |
|
|
| signing_secret | [_RequiredSecret](#_requiredsecret) | Slack callback signing secret. | Yes |
|
|
|
|
#### SlackCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_token | [Redacted](#redacted) | | Yes |
|
|
| bot_token | [Redacted](#redacted) | | Yes |
|
|
| client_id | string | | Yes |
|
|
| client_secret | [Redacted](#redacted) | | Yes |
|
|
| provider | string | | Yes |
|
|
| signing_secret | [Redacted](#redacted) | | Yes |
|
|
|
|
#### SlackCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_token | [_OptionalSecret](#_optionalsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| bot_token | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| client_id | [_Identifier](#_identifier)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| client_secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
| signing_secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
|
|
#### SnippetDependencyCheckResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| leaked_dependencies | [ [PluginDependency](#plugindependency) ] | | Yes |
|
|
|
|
#### SnippetDraftConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| parallel_depth_limit | integer | | Yes |
|
|
|
|
#### SnippetDraftNodeRunPayload
|
|
|
|
Payload for running a single node in snippet draft workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
| query | string | | No |
|
|
|
|
#### SnippetDraftRunPayload
|
|
|
|
Payload for running snippet draft workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
|
|
#### SnippetDraftSyncPayload
|
|
|
|
Payload for syncing snippet draft workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_variables | [ object ] | Ignored. Snippet workflows do not persist conversation variables. | No |
|
|
| graph | object | | Yes |
|
|
| hash | string | | No |
|
|
| input_fields | [ object ] | | No |
|
|
|
|
#### SnippetExportQuery
|
|
|
|
Query parameters for exporting a snippet workflow as DSL.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| include_secret | string, <br>**Default:** false | Whether to include secret variables | No |
|
|
| workflow_id | string | Specific published workflow version to export | No |
|
|
|
|
#### SnippetImportPayload
|
|
|
|
Payload for importing snippet from DSL.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | Override snippet description | No |
|
|
| mode | string | Import mode: yaml-content or yaml-url | Yes |
|
|
| name | string | Override snippet name | No |
|
|
| snippet_id | string | Snippet ID to update (optional) | No |
|
|
| yaml_content | string | YAML content (required for yaml-content mode) | No |
|
|
| yaml_url | string | YAML URL (required for yaml-url mode) | No |
|
|
|
|
#### SnippetImportResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_dsl_version | string | | Yes |
|
|
| error | string | | Yes |
|
|
| id | string | | Yes |
|
|
| imported_dsl_version | string | | Yes |
|
|
| snippet_id | string | | Yes |
|
|
| status | [ImportStatus](#importstatus) | | Yes |
|
|
| warnings | [ [DslImportWarning](#dslimportwarning) ] | | Yes |
|
|
|
|
#### SnippetIterationNodeRunPayload
|
|
|
|
Payload for running an iteration node in snippet draft workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | | No |
|
|
|
|
#### SnippetListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author_name | string | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | string | | Yes |
|
|
| description | string | | Yes |
|
|
| icon_info | object | | Yes |
|
|
| id | string | | Yes |
|
|
| is_published | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| tags | [ [SnippetTagResponse](#snippettagresponse) ] | | Yes |
|
|
| type | [SnippetType](#snippettype) | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | string | | Yes |
|
|
| use_count | integer | | Yes |
|
|
| version | integer | | Yes |
|
|
|
|
#### SnippetListQuery
|
|
|
|
Query parameters for listing snippets.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| creators | [ string ] | Filter by creator account IDs | No |
|
|
| is_published | boolean | Filter by published status | No |
|
|
| keyword | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
| tag_ids | [ string ] | Filter by tag IDs | No |
|
|
|
|
#### SnippetLoopNodeRunPayload
|
|
|
|
Payload for running a loop node in snippet draft workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| inputs | object | | No |
|
|
|
|
#### SnippetPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [SnippetListItemResponse](#snippetlistitemresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### SnippetPublishWorkflowPayload
|
|
|
|
Payload for publishing snippet workflow.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| knowledge_base_setting | object | | No |
|
|
| marked_comment | string | | No |
|
|
| marked_name | string | | No |
|
|
|
|
#### SnippetResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| created_by | [SimpleAccountResponse](#simpleaccountresponse) | | Yes |
|
|
| description | string | | Yes |
|
|
| graph | object | | Yes |
|
|
| icon_info | object | | Yes |
|
|
| id | string | | Yes |
|
|
| input_fields | [ object ] | | Yes |
|
|
| is_published | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| tags | [ [SnippetTagResponse](#snippettagresponse) ] | | Yes |
|
|
| type | [SnippetType](#snippettype) | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | [SimpleAccountResponse](#simpleaccountresponse) | | Yes |
|
|
| use_count | integer | | Yes |
|
|
| version | integer | | Yes |
|
|
|
|
#### SnippetTagResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### SnippetType
|
|
|
|
Snippet Type Enum
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SnippetType | string | Snippet Type Enum | |
|
|
|
|
#### SnippetUseCountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | | Yes |
|
|
| use_count | integer | | Yes |
|
|
|
|
#### SnippetWorkflowListQuery
|
|
|
|
Query parameters for listing snippet published workflows.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 10 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### SnippetWorkflowPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| has_more | boolean | | Yes |
|
|
| items | [ [SnippetWorkflowResponse](#snippetworkflowresponse) ] | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
|
|
#### SnippetWorkflowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_variables | [ [WorkflowConversationVariableResponse](#workflowconversationvariableresponse) ] | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| environment_variables | [ [WorkflowEnvironmentVariableResponse](#workflowenvironmentvariableresponse) ] | | Yes |
|
|
| features | object | | Yes |
|
|
| graph | object | | Yes |
|
|
| hash | string | | Yes |
|
|
| id | string | | Yes |
|
|
| input_fields | [ object ] | | No |
|
|
| marked_comment | string | | Yes |
|
|
| marked_name | string | | Yes |
|
|
| rag_pipeline_variables | [ [PipelineVariableResponse](#pipelinevariableresponse) ] | | Yes |
|
|
| tool_published | boolean | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| version | string | | Yes |
|
|
| version_number | integer | | No |
|
|
|
|
#### SnippetWorkflowRunQuery
|
|
|
|
Query parameters for workflow runs.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_id | string | | No |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
|
|
#### SpeechToTextDisabledError
|
|
|
|
Speech to text is disabled.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| SpeechToTextDisabledError | | Speech to text is disabled. | |
|
|
|
|
#### StarredAppListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| creator_ids | [ string ] | Filter by creator account IDs | No |
|
|
| is_created_by_me | boolean | Filter by creator | No |
|
|
| limit | integer, <br>**Default:** 20 | Page size (1-100) | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "agent", "agent-chat", "all", "channel", "chat", "completion", "workflow", <br>**Default:** all | App mode filter<br>*Enum:* `"advanced-chat"`, `"agent"`, `"agent-chat"`, `"all"`, `"channel"`, `"chat"`, `"completion"`, `"workflow"` | No |
|
|
| name | string | Filter by app name | No |
|
|
| openapi_visible | boolean | Only return apps with API access enabled | No |
|
|
| page | integer, <br>**Default:** 1 | Page number (1-99999) | No |
|
|
| sort_by | string, <br>**Available values:** "earliest_created", "last_modified", "recently_created", <br>**Default:** last_modified | Sort apps by last modified, recently created, or earliest created<br>*Enum:* `"earliest_created"`, `"last_modified"`, `"recently_created"` | No |
|
|
| tag_ids | [ string ] | Filter by tag IDs | No |
|
|
|
|
#### StatisticTimeRangeQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| end | string | End date (YYYY-MM-DD HH:MM) | No |
|
|
| start | string | Start date (YYYY-MM-DD HH:MM) | No |
|
|
|
|
#### StatusCount
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| failed | integer | | Yes |
|
|
| partial_success | integer | | Yes |
|
|
| paused | integer | | Yes |
|
|
| success | integer | | Yes |
|
|
|
|
#### StepByStepTourStatePatchPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| action | string, <br>**Available values:** "complete_task", "disable_current_workspace", "enable_current_workspace", "skip", "uncomplete_task" | State update action<br>*Enum:* `"complete_task"`, `"disable_current_workspace"`, `"enable_current_workspace"`, `"skip"`, `"uncomplete_task"` | Yes |
|
|
| task_id | string, <br>**Available values:** "home", "integration", "knowledge", "studio" | Task ID for task actions | No |
|
|
|
|
#### StepByStepTourStateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed_task_ids | [ string, <br>**Available values:** "home", "integration", "knowledge", "studio" ] | | No |
|
|
| first_workspace_id | string | | No |
|
|
| manually_disabled_workspace_ids | [ string ] | | No |
|
|
| manually_enabled_workspace_ids | [ string ] | | No |
|
|
| skipped | boolean | | No |
|
|
| updated_at | string | | No |
|
|
|
|
#### Storage
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| size | integer, <br>**Default:** 1048576 | | No |
|
|
|
|
#### StringListSource
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| selector | [ string ] | Variable reference path when `type` is `variable`. | No |
|
|
| type | [ValueSourceType](#valuesourcetype) | Origin of the options. `constant` means `value` lists the options literally; `variable` means `selector` points to an `array[string]` workflow variable that provides them. | Yes |
|
|
| value | [ string ] | Literal option list when `type` is `constant`. | No |
|
|
|
|
#### StringSource
|
|
|
|
Default configuration for form inputs.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| selector | [ string ] | | No |
|
|
| type | [ValueSourceType](#valuesourcetype) | | Yes |
|
|
| value | string | | No |
|
|
|
|
#### StructuredOutputGenerateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | Failure reason, empty on success | Yes |
|
|
| output | string | Generated JSON Schema, empty when generation failed | Yes |
|
|
|
|
#### SubscriptionBuilderApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_type | [CredentialType](#credentialtype) | The credential type of the subscription builder | Yes |
|
|
| credentials | object | The credentials of the subscription builder | Yes |
|
|
| endpoint | string | The endpoint id of the subscription builder | Yes |
|
|
| id | string | The id of the subscription builder | Yes |
|
|
| name | string | The name of the subscription builder | Yes |
|
|
| parameters | object | The parameters of the subscription builder | Yes |
|
|
| properties | object | The properties of the subscription builder | Yes |
|
|
| provider | string | The provider id of the subscription builder | Yes |
|
|
|
|
#### SubscriptionConstructor
|
|
|
|
The subscription constructor of the trigger provider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | The credentials schema of the subscription constructor | No |
|
|
| oauth_schema | [OAuthSchema](#oauthschema) | The OAuth schema of the subscription constructor if OAuth is supported | No |
|
|
| parameters | [ [EventParameter](#eventparameter) ] | The parameters schema of the subscription constructor | No |
|
|
|
|
#### SubscriptionModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| interval | string, <br>**Available values:** "", "month", "year" | *Enum:* `""`, `"month"`, `"year"` | Yes |
|
|
| plan | [CloudPlan](#cloudplan) | | Yes |
|
|
|
|
#### SubscriptionQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| interval | string, <br>**Available values:** "month", "year" | Billing interval<br>*Enum:* `"month"`, `"year"` | Yes |
|
|
| plan | string, <br>**Available values:** "professional", "team" | Subscription plan<br>*Enum:* `"professional"`, `"team"` | Yes |
|
|
|
|
#### SuccessResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| success | boolean | | Yes |
|
|
|
|
#### SuggestedQuestionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ string ] | | Yes |
|
|
|
|
#### SummaryEntryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| error | string | | No |
|
|
| segment_id | string | | Yes |
|
|
| segment_position | integer | | Yes |
|
|
| status | string | | Yes |
|
|
| summary_preview | string | | No |
|
|
| updated_at | integer | | No |
|
|
|
|
#### SummaryStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completed | integer | | No |
|
|
| error | integer | | No |
|
|
| generating | integer | | No |
|
|
| not_started | integer | | No |
|
|
| timeout | integer | | No |
|
|
|
|
#### SwitchWorkspacePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tenant_id | string | | Yes |
|
|
|
|
#### SwitchWorkspaceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| new_tenant | [TenantInfoResponse](#tenantinforesponse) | | Yes |
|
|
| result | string | | Yes |
|
|
|
|
#### SyncDraftWorkflowPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| _is_collaborative | boolean | | No |
|
|
| conversation_variables | [ object ] | | No |
|
|
| environment_variable_patch | [SyncEnvironmentVariablePatchPayload](#syncenvironmentvariablepatchpayload) | | No |
|
|
| features | object | | Yes |
|
|
| force | boolean | Explicitly confirm saving an empty workflow graph. | No |
|
|
| graph | object | | Yes |
|
|
| hash | string | | No |
|
|
|
|
#### SyncDraftWorkflowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| hash | string | | Yes |
|
|
| result | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
|
|
#### SyncEnvironmentVariablePatchPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| deleted_environment_variable_ids | [ string ] | | No |
|
|
| environment_variables | [ object ] | | No |
|
|
|
|
#### SystemConfigurationResponse
|
|
|
|
Model class for provider system configuration response.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_quota_type | [ProviderQuotaType](#providerquotatype) | | No |
|
|
| enabled | boolean | | Yes |
|
|
| quota_configurations | [ [QuotaConfiguration](#quotaconfiguration) ], <br>**Default:** | | No |
|
|
|
|
#### SystemFeatureModel
|
|
|
|
Non-sensitive bootstrap snapshot exposed before Console or Web authentication.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_tracing_api_collection_enabled | boolean | Deployment-level API gate for Agent trace collection, independent of workspace and provider configuration. Does not indicate Agent runtime, worker, or provider health or confirm trace delivery. | Yes |
|
|
| branding | [BrandingModel](#brandingmodel) | | Yes |
|
|
| deployment_edition | [DeploymentEdition](#deploymentedition) | | Yes |
|
|
| enable_app_deploy | boolean | | Yes |
|
|
| enable_change_email | boolean, <br>**Default:** true | | Yes |
|
|
| enable_collaboration_mode | boolean, <br>**Default:** true | | Yes |
|
|
| enable_creators_platform | boolean | | Yes |
|
|
| enable_email_code_login | boolean | | Yes |
|
|
| enable_email_password_login | boolean, <br>**Default:** true | | Yes |
|
|
| enable_explore_banner | boolean | | Yes |
|
|
| enable_learn_app | boolean, <br>**Default:** true | | Yes |
|
|
| enable_marketplace | boolean | | Yes |
|
|
| enable_social_oauth_login | boolean | | Yes |
|
|
| enable_step_by_step_tour | boolean | | Yes |
|
|
| is_allow_register | boolean | | Yes |
|
|
| is_email_setup | boolean | | Yes |
|
|
| license | [LicenseStatusModel](#licensestatusmodel) | | Yes |
|
|
| plugin_installation_permission | [PluginInstallationPermissionModel](#plugininstallationpermissionmodel) | | Yes |
|
|
| rbac_enabled | boolean | | Yes |
|
|
| sso_enforced_for_signin | boolean | | Yes |
|
|
| sso_enforced_for_signin_protocol | [SSOProtocol](#ssoprotocol) | | Yes |
|
|
| webapp_auth | [WebAppAuthModel](#webappauthmodel) | | Yes |
|
|
|
|
#### SystemParameters
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| audio_file_size_limit | integer | | Yes |
|
|
| file_size_limit | integer | | Yes |
|
|
| image_file_size_limit | integer | | Yes |
|
|
| video_file_size_limit | integer | | Yes |
|
|
| workflow_file_upload_limit | integer | | Yes |
|
|
|
|
#### Tag
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### TagBasePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | Tag name | Yes |
|
|
| type | [TagType](#tagtype) | | Yes |
|
|
|
|
#### TagBindingPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tag_ids | [ string ] | Tag IDs to bind | Yes |
|
|
| target_id | string | Target ID to bind tags to | Yes |
|
|
| type | [TagType](#tagtype) | | Yes |
|
|
|
|
#### TagBindingRemovePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tag_ids | [ string ] | Tag IDs to remove | Yes |
|
|
| target_id | string | Target ID to unbind tag from | Yes |
|
|
| type | [TagType](#tagtype) | | Yes |
|
|
|
|
#### TagListQueryParam
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Search keyword | No |
|
|
| type | string, <br>**Available values:** "app", "knowledge", "skill", "snippet" | Tag type filter<br>*Enum:* `"app"`, `"knowledge"`, `"skill"`, `"snippet"` | Yes |
|
|
|
|
#### TagListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TagListResponse | array | | |
|
|
|
|
#### TagResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| binding_count | string | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string | | No |
|
|
|
|
#### TagType
|
|
|
|
Tag type
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TagType | string | Tag type | |
|
|
|
|
#### TagUpdateRequestPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | Tag name | Yes |
|
|
|
|
#### TenantAccountRole
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TenantAccountRole | string | | |
|
|
|
|
#### TenantInfoResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| custom_config | [WorkspaceCustomConfigResponse](#workspacecustomconfigresponse) | | No |
|
|
| id | string | | Yes |
|
|
| in_trial | boolean | | No |
|
|
| name | string | | No |
|
|
| next_credit_reset_date | integer | | No |
|
|
| plan | [CloudPlan](#cloudplan) | | No |
|
|
| role | string | | No |
|
|
| status | string | | No |
|
|
| trial_credits | integer | | No |
|
|
| trial_credits_exhausted_at | integer | | No |
|
|
| trial_credits_used | integer | | No |
|
|
| trial_end_reason | string | | No |
|
|
|
|
#### TenantListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| current | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| last_opened_at | integer | | No |
|
|
| name | string | | No |
|
|
| plan | [CloudPlan](#cloudplan) | | No |
|
|
| status | string | | No |
|
|
|
|
#### TenantListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| workspaces | [ [TenantListItemResponse](#tenantlistitemresponse) ] | | Yes |
|
|
|
|
#### TenantPluginAutoUpgradeCategory
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TenantPluginAutoUpgradeCategory | string | | |
|
|
|
|
#### TenantPluginAutoUpgradeMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TenantPluginAutoUpgradeMode | string | | |
|
|
|
|
#### TenantPluginAutoUpgradeStrategySetting
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TenantPluginAutoUpgradeStrategySetting | string | | |
|
|
|
|
#### TenantPluginDebugPermission
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TenantPluginDebugPermission | string | | |
|
|
|
|
#### TenantPluginInstallPermission
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TenantPluginInstallPermission | string | | |
|
|
|
|
#### TextContentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
|
|
#### TextFileResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TextFileResponse | string | | |
|
|
|
|
#### TextToAudioPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message_id | string | Message ID. Takes priority over `text` when both are provided. | No |
|
|
| streaming | boolean | Reserved for compatibility; TTS response streaming is determined by the provider output. | No |
|
|
| text | string | Speech content to convert. | No |
|
|
| voice | string | Voice to use for text-to-speech. Available voices depend on the TTS provider configured for this app. Omit to use the app's configured voice when available; that value is exposed by [Get App Parameters](/api-reference/applications/get-app-parameters) as `text_to_speech.voice`. | No |
|
|
|
|
#### TextToSpeechPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message_id | string | Message ID | No |
|
|
| streaming | boolean | Whether to stream audio | No |
|
|
| text | string | Text to convert | Yes |
|
|
| voice | string | Voice name | No |
|
|
|
|
#### TextToSpeechRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| message_id | string | | No |
|
|
| streaming | boolean | | No |
|
|
| text | string | | No |
|
|
| voice | string | | No |
|
|
|
|
#### TextToSpeechVoiceListResponse
|
|
|
|
Available voices
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TextToSpeechVoiceListResponse | array | Available voices | |
|
|
|
|
#### TextToSpeechVoiceQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string | Language code | Yes |
|
|
|
|
#### TextToSpeechVoiceResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | Voice display name | Yes |
|
|
| value | string | Voice identifier | Yes |
|
|
|
|
#### TimeoutUnit
|
|
|
|
Timeout unit for form expiration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TimeoutUnit | string | Timeout unit for form expiration. | |
|
|
|
|
#### TimeoutUnit_Strict_strict_False_
|
|
|
|
Timeout unit for form expiration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TimeoutUnit_Strict_strict_False_ | string | Timeout unit for form expiration. | |
|
|
|
|
#### TokensPerSecondStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| tps | number | | Yes |
|
|
|
|
#### TokensPerSecondStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [TokensPerSecondStatisticItem](#tokenspersecondstatisticitem) ] | | Yes |
|
|
|
|
#### TooManyFilesError
|
|
|
|
Only one file is allowed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TooManyFilesError | | Only one file is allowed. | |
|
|
|
|
#### Tool
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
|
|
#### ToolApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | | Yes |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| name | string | | Yes |
|
|
| output_schema | object | | No |
|
|
| parameters | [ [ToolParameter](#toolparameter) ] | | No |
|
|
|
|
#### ToolApiListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolApiListResponse | array | | |
|
|
|
|
#### ToolEmojiIcon
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| background | string | | Yes |
|
|
| content | string | | Yes |
|
|
|
|
#### ToolLabel
|
|
|
|
Tool label
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| icon | string | The icon of the tool | Yes |
|
|
| label | [I18nObject](#i18nobject) | The label of the tool | Yes |
|
|
| name | string | The name of the tool | Yes |
|
|
|
|
#### ToolLabelEnum
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolLabelEnum | string | | |
|
|
|
|
#### ToolLabelListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolLabelListResponse | array | | |
|
|
|
|
#### ToolOAuthAuthorizationQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| visibility | string, <br>**Available values:** "all_team_members", "only_me" | Visibility for the OAuth credential. Defaults to 'only_me'. | No |
|
|
|
|
#### ToolOAuthCustomClientPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_params | object | | No |
|
|
| enable_oauth_custom_client | boolean | | No |
|
|
|
|
#### ToolParameter
|
|
|
|
Tool-specific parameter declaration and invocation-value normalization.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| auto_generate | [PluginParameterAutoGenerate](#pluginparameterautogenerate) | | No |
|
|
| default | number<br>integer<br>string<br>boolean<br>[ object ]<br>object | | No |
|
|
| form | [ToolParameterForm](#toolparameterform) | The form of the parameter, schema/form/llm | Yes |
|
|
| human_description | [I18nObject](#i18nobject) | The description presented to the user | No |
|
|
| input_schema | object | | No |
|
|
| label | [I18nObject](#i18nobject) | The label presented to the user | Yes |
|
|
| llm_description | string | | No |
|
|
| max | number<br>integer | | No |
|
|
| min | number<br>integer | | No |
|
|
| multiple | boolean | Whether the parameter is multiple select, only valid for select or dynamic-select type | No |
|
|
| name | string | The name of the parameter | Yes |
|
|
| options | [ [PluginParameterOption](#pluginparameteroption) ] | | No |
|
|
| placeholder | [I18nObject](#i18nobject) | The placeholder presented to the user | No |
|
|
| precision | integer | | No |
|
|
| required | boolean | | No |
|
|
| scope | string | | No |
|
|
| template | [PluginParameterTemplate](#pluginparametertemplate) | | No |
|
|
| type | [ToolParameterType](#toolparametertype) | The type of the parameter | Yes |
|
|
|
|
#### ToolParameterForm
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolParameterForm | string | | |
|
|
|
|
#### ToolParameterType
|
|
|
|
removes TOOLS_SELECTOR from PluginParameterType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolParameterType | string | removes TOOLS_SELECTOR from PluginParameterType | |
|
|
|
|
#### ToolProviderApiEntityResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allow_delete | boolean, <br>**Default:** true | | No |
|
|
| authentication | [MCPAuthentication](#mcpauthentication) | The OAuth config of the MCP tool | No |
|
|
| author | string | | Yes |
|
|
| configuration | [MCPConfiguration](#mcpconfiguration) | The timeout and sse_read_timeout of the MCP tool | No |
|
|
| description | [I18nObject](#i18nobject) | | Yes |
|
|
| icon | string<br>object | | Yes |
|
|
| icon_dark | string<br>object | | No |
|
|
| id | string | | Yes |
|
|
| identity_mode | string, <br>**Default:** off | Identity-forwarding mechanism: 'off' or 'idp_token' | No |
|
|
| is_dynamic_registration | boolean, <br>**Default:** true | Whether the MCP tool is dynamically registered | No |
|
|
| is_team_authorization | boolean | | No |
|
|
| label | [I18nObject](#i18nobject) | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| masked_headers | object | The masked headers of the MCP tool | No |
|
|
| name | string | | Yes |
|
|
| original_headers | object | The original headers of the MCP tool | No |
|
|
| plugin_id | string | The plugin id of the tool | No |
|
|
| plugin_unique_identifier | string | The unique identifier of the tool | No |
|
|
| server_identifier | string | The server identifier of the MCP tool | No |
|
|
| server_url | string | The server url of the tool | No |
|
|
| team_credentials | object | | No |
|
|
| tools | [ [ToolApiEntity](#toolapientity) ] | | No |
|
|
| type | [ToolProviderType](#toolprovidertype) | | Yes |
|
|
| updated_at | integer | | No |
|
|
| workflow_app_id | string | The app id of the workflow tool | No |
|
|
|
|
#### ToolProviderCredentialApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_by | string | User ID of the credential creator | No |
|
|
| credential_type | [CredentialType](#credentialtype) | The type of the credential | Yes |
|
|
| credentials | object | The credentials of the provider | No |
|
|
| from_other_member | boolean | True when this credential is being returned only because a workflow/agent node still references it but it would normally be hidden from this user by the visibility filter (another member's only_me credential). The frontend renders it as 'borrowed' — selectable until the node switches away, but not editable/deletable. | No |
|
|
| id | string | The unique id of the credential | Yes |
|
|
| is_default | boolean | Whether the credential is the default credential for the provider in the workspace | No |
|
|
| name | string | The name of the credential | Yes |
|
|
| partial_member_list | [ string ] | List of user IDs allowed when visibility is partial_members | No |
|
|
| provider | string | The provider of the credential | Yes |
|
|
| visibility | string, <br>**Default:** all_team_members | Credential visibility: only_me, all_team_members, or partial_members | No |
|
|
|
|
#### ToolProviderCredentialInfoApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | [ [ToolProviderCredentialApiEntity](#toolprovidercredentialapientity) ] | The credentials of the provider | Yes |
|
|
| is_oauth_custom_client_enabled | boolean | Whether the OAuth custom client is enabled for the provider | No |
|
|
| supported_credential_types | [ [CredentialType](#credentialtype) ] | The supported credential types of the provider | Yes |
|
|
|
|
#### ToolProviderCredentialListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolProviderCredentialListResponse | array | | |
|
|
|
|
#### ToolProviderEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials_schema | [ [ProviderConfig](#providerconfig) ] | | No |
|
|
| identity | [ToolProviderIdentity](#toolprovideridentity) | | Yes |
|
|
| oauth_schema | [OAuthSchema](#oauthschema) | | No |
|
|
| plugin_id | string | | No |
|
|
|
|
#### ToolProviderIdentity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the tool | Yes |
|
|
| description | [I18nObject](#i18nobject) | The description of the tool | Yes |
|
|
| icon | string | The icon of the tool | Yes |
|
|
| icon_dark | string | The dark icon of the tool | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the tool | Yes |
|
|
| name | string | The name of the tool | Yes |
|
|
| tags | [ [ToolLabelEnum](#toollabelenum) ] | The tags of the tool | No |
|
|
|
|
#### ToolProviderListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string, <br>**Available values:** "api", "builtin", "mcp", "model", "workflow" | | No |
|
|
|
|
#### ToolProviderListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolProviderListResponse | array | | |
|
|
|
|
#### ToolProviderType
|
|
|
|
Enum class for tool provider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolProviderType | string | Enum class for tool provider | |
|
|
|
|
#### ToolSelectorScope
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ToolSelectorScope | string | | |
|
|
|
|
#### TraceAppConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | No |
|
|
| configured_secrets | [ string ] | Secret fields that hold a value; submit them empty to keep that value | No |
|
|
| created_at | string | | No |
|
|
| error | string | | No |
|
|
| has_not_configured | boolean | | No |
|
|
| id | string | | No |
|
|
| is_active | boolean | | No |
|
|
| result | string | | No |
|
|
| tracing_config | object | Non-secret fields; secrets are write-only and never returned | No |
|
|
| tracing_provider | string | | No |
|
|
| updated_at | string | | No |
|
|
|
|
#### TraceConfigAlreadyExistsError
|
|
|
|
A tracing configuration already exists for this provider.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TraceConfigAlreadyExistsError | | A tracing configuration already exists for this provider. | |
|
|
|
|
#### TraceConfigNotFoundError
|
|
|
|
Tracing configuration not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TraceConfigNotFoundError | | Tracing configuration not found. | |
|
|
|
|
#### TraceConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| activate | boolean | Save, select this provider, and enable tracing atomically; preserve capture settings | No |
|
|
| tracing_config | object | Tracing configuration data | Yes |
|
|
| tracing_provider | string | Tracing provider name | Yes |
|
|
|
|
#### TraceProviderCapabilitiesResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_spans | boolean | | Yes |
|
|
| api_collection_enabled | boolean | Current API collection gate only; does not probe Agent runtime or confirm delivery | Yes |
|
|
| export_ack | string | Exporter acknowledgement does not confirm query visibility | Yes |
|
|
| native_cost | boolean | | Yes |
|
|
| native_usage | boolean | | Yes |
|
|
| provider | string | | Yes |
|
|
| session | boolean | | Yes |
|
|
| span_url | boolean | | Yes |
|
|
| trace_url | boolean | | Yes |
|
|
|
|
#### TraceProviderQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| tracing_provider | string | Tracing provider name | Yes |
|
|
|
|
#### TraceProviderSupportResponse
|
|
|
|
Adapter support declarations, not successful-delivery or platform-verification results.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_spans | boolean | | Yes |
|
|
| export_ack | string | Exporter acknowledgement does not confirm query visibility | Yes |
|
|
| native_cost | boolean | | Yes |
|
|
| native_usage | boolean | | Yes |
|
|
| provider | string | | Yes |
|
|
| session | boolean | | Yes |
|
|
| span_url | boolean | | Yes |
|
|
| trace_url | boolean | | Yes |
|
|
|
|
#### TraceRunQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_execution_id | string | Select an Agent node invocation within this run | No |
|
|
|
|
#### TraceRunRetryPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| acknowledge_possible_duplicates | boolean | Acknowledge possible duplicate records when retrying an uncertain export | No |
|
|
|
|
#### TraceRunStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| accepted_at | string | Ingestion acknowledgement time, not query visibility | No |
|
|
| attempts | integer | | No |
|
|
| capabilities | [TraceProviderSupportResponse](#traceprovidersupportresponse) | | No |
|
|
| capture_agent | boolean | | No |
|
|
| capture_content | boolean | | No |
|
|
| config_revision | string | Frozen destination configuration revision | No |
|
|
| error_code | string | | No |
|
|
| project_url | string | Frozen destination project URL; null when unavailable, never resolved from current config | No |
|
|
| provider | string | | No |
|
|
| queryable | boolean | Null when third-party query visibility is not verified | No |
|
|
| source_id | string | | Yes |
|
|
| source_kind | [TraceSourceKind](#tracesourcekind) | | Yes |
|
|
| span_count | integer | | No |
|
|
| span_url | string | | No |
|
|
| status | string, <br>**Available values:** "accepted", "collecting", "exporting", "failed", "not_collected", "ready", "retrying", "uncertain" | *Enum:* `"accepted"`, `"collecting"`, `"exporting"`, `"failed"`, `"not_collected"`, `"ready"`, `"retrying"`, `"uncertain"` | Yes |
|
|
| trace_id | string | | No |
|
|
| trace_url | string | | No |
|
|
|
|
#### TraceSourceKind
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TraceSourceKind | string | | |
|
|
|
|
#### TracingAlreadyAcceptedError
|
|
|
|
An accepted trace cannot be exported again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingAlreadyAcceptedError | | An accepted trace cannot be exported again. | |
|
|
|
|
#### TracingConfigConflictError
|
|
|
|
Tracing configuration changed. Refresh and try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingConfigConflictError | | Tracing configuration changed. Refresh and try again. | |
|
|
|
|
#### TracingConfigProcessingFailedError
|
|
|
|
The tracing configuration could not be processed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingConfigProcessingFailedError | | The tracing configuration could not be processed. | |
|
|
|
|
#### TracingConfigVerificationFailedError
|
|
|
|
The tracing configuration could not be verified.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingConfigVerificationFailedError | | The tracing configuration could not be verified. | |
|
|
|
|
#### TracingDuplicateAcknowledgementRequiredError
|
|
|
|
Acknowledge possible duplicates before retrying an uncertain export.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingDuplicateAcknowledgementRequiredError | | Acknowledge possible duplicates before retrying an uncertain export. | |
|
|
|
|
#### TracingNodeNotFoundError
|
|
|
|
The Agent node invocation does not belong to this trace.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingNodeNotFoundError | | The Agent node invocation does not belong to this trace. | |
|
|
|
|
#### TracingProviderUnavailableError
|
|
|
|
The tracing provider is not available in this deployment.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingProviderUnavailableError | | The tracing provider is not available in this deployment. | |
|
|
|
|
#### TracingRetryNotAllowedError
|
|
|
|
This trace is not in a retryable state.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingRetryNotAllowedError | | This trace is not in a retryable state. | |
|
|
|
|
#### TracingRunNotFoundError
|
|
|
|
No collected trace is available to retry.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingRunNotFoundError | | No collected trace is available to retry. | |
|
|
|
|
#### TracingSourceNotFoundError
|
|
|
|
The tracing source does not exist in this application.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TracingSourceNotFoundError | | The tracing source does not exist in this application. | |
|
|
|
|
#### TrialAgentConfigQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| version_id | string | Must match the current published template snapshot | No |
|
|
|
|
#### TrialAgentSkillFileQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| path | string | Normalized member path inside the published Skill package | Yes |
|
|
| version_id | string | Must match the current published template snapshot | No |
|
|
|
|
#### TrialAppAgentMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| strategy | string | | No |
|
|
| tools | [ [JsonObject](#jsonobject) ] | | No |
|
|
|
|
#### TrialAppDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_mode | string | | No |
|
|
| api_base_url | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| deleted_tools | [ [TrialDeletedToolResponse](#trialdeletedtoolresponse) ] | | No |
|
|
| description | string | | No |
|
|
| enable_api | boolean | | Yes |
|
|
| enable_site | boolean | | Yes |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [TrialIconType](#trialicontype) | | No |
|
|
| icon_url | string | | No |
|
|
| id | string | | Yes |
|
|
| max_active_requests | integer | | No |
|
|
| mode | [TrialAppMode](#trialappmode) | | Yes |
|
|
| model_config | [TrialAppModelConfigResponse](#trialappmodelconfigresponse) | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ] | | No |
|
|
| site | [TrialSiteResponse](#trialsiteresponse) | | Yes |
|
|
| tags | [ [TrialTagResponse](#trialtagresponse) ] | | No |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| use_icon_as_answer_icon | boolean | | No |
|
|
| workflow | [TrialWorkflowPartialResponse](#trialworkflowpartialresponse) | | No |
|
|
|
|
#### TrialAppFeatureDisabledError
|
|
|
|
Trial app feature is not enabled.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TrialAppFeatureDisabledError | | Trial app feature is not enabled. | |
|
|
|
|
#### TrialAppLimitExceededError
|
|
|
|
The user has exceeded the trial app limit.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TrialAppLimitExceededError | | The user has exceeded the trial app limit. | |
|
|
|
|
#### TrialAppMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TrialAppMode | string | | |
|
|
|
|
#### TrialAppModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| completion_params | [JsonObject](#jsonobject) | | No |
|
|
| mode | string | | No |
|
|
| name | string | | Yes |
|
|
| provider | string | | Yes |
|
|
|
|
#### TrialAppModelConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_mode | [TrialAppAgentMode](#trialappagentmode) | | No |
|
|
| annotation_reply | [JsonObject](#jsonobject) | | No |
|
|
| chat_prompt_config | [JsonObject](#jsonobject) | | No |
|
|
| completion_prompt_config | [JsonObject](#jsonobject) | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| dataset_configs | [JsonObject](#jsonobject) | | No |
|
|
| dataset_query_variable | string | | No |
|
|
| external_data_tools | [ [JsonObject](#jsonobject) ] | | No |
|
|
| file_upload | [JsonObject](#jsonobject) | | No |
|
|
| model | [TrialAppModel](#trialappmodel) | | No |
|
|
| more_like_this | [JsonObject](#jsonobject) | | No |
|
|
| opening_statement | string | | No |
|
|
| pre_prompt | string | | No |
|
|
| prompt_type | string | | No |
|
|
| retriever_resource | [JsonObject](#jsonobject) | | No |
|
|
| sensitive_word_avoidance | [JsonObject](#jsonobject) | | No |
|
|
| speech_to_text | [JsonObject](#jsonobject) | | No |
|
|
| suggested_questions | [ string ] | | No |
|
|
| suggested_questions_after_answer | [JsonObject](#jsonobject) | | No |
|
|
| text_to_speech | [JsonObject](#jsonobject) | | No |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| user_input_form | [ [JsonObject](#jsonobject) ] | | No |
|
|
|
|
#### TrialAppNotAllowedError
|
|
|
|
the app is not allowed to be trial.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TrialAppNotAllowedError | | the app is not allowed to be trial. | |
|
|
|
|
#### TrialDatasetListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ids | [ string ] | Dataset IDs | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of items per page | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
|
|
#### TrialDatasetListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [TrialDatasetResponse](#trialdatasetresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### TrialDatasetResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| data_source_type | string | | No |
|
|
| description | string | | No |
|
|
| id | string | | Yes |
|
|
| indexing_technique | string | | No |
|
|
| name | string | | Yes |
|
|
| permission | string | | No |
|
|
| permission_keys | [ string ] | | No |
|
|
|
|
#### TrialDeletedToolResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| provider_id | string | | Yes |
|
|
| tool_name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### TrialIconType
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TrialIconType | string | | |
|
|
|
|
#### TrialModelsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| trial_models | [ string ] | | Yes |
|
|
|
|
#### TrialSimpleAccount
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | No |
|
|
|
|
#### TrialSiteResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| access_token | string | | No |
|
|
| app_base_url | string | | No |
|
|
| chat_color_theme | string | | No |
|
|
| chat_color_theme_inverted | boolean | | No |
|
|
| code | string | | No |
|
|
| copyright | string | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| custom_disclaimer | string | | No |
|
|
| customize_domain | string | | No |
|
|
| customize_token_strategy | string | | No |
|
|
| default_language | string | | Yes |
|
|
| description | string | | No |
|
|
| icon | string | | No |
|
|
| icon_background | string | | No |
|
|
| icon_type | [TrialIconType](#trialicontype) | | No |
|
|
| icon_url | string | | No |
|
|
| input_placeholder | string | | No |
|
|
| privacy_policy | string | | No |
|
|
| prompt_public | boolean | | No |
|
|
| show_workflow_steps | boolean | | No |
|
|
| title | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
| use_icon_as_answer_icon | boolean | | No |
|
|
|
|
#### TrialTagResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### TrialWorkflowPartialResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| id | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
|
|
#### TrialWorkflowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_variables | [ [WorkflowConversationVariableResponse](#workflowconversationvariableresponse) ] | | No |
|
|
| created_at | integer | | No |
|
|
| created_by | [TrialSimpleAccount](#trialsimpleaccount) | | No |
|
|
| environment_variables | [ [JsonObject](#jsonobject) ] | | No |
|
|
| features | [JsonObject](#jsonobject) | | No |
|
|
| graph | [JsonObject](#jsonobject) | | Yes |
|
|
| hash | string | | No |
|
|
| id | string | | Yes |
|
|
| marked_comment | string | | No |
|
|
| marked_name | string | | No |
|
|
| rag_pipeline_variables | [ [JsonObject](#jsonobject) ] | | No |
|
|
| tool_published | boolean | | No |
|
|
| updated_at | integer | | No |
|
|
| updated_by | [TrialSimpleAccount](#trialsimpleaccount) | | No |
|
|
| version | string | | No |
|
|
|
|
#### TriggerCreationMethod
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TriggerCreationMethod | string | | |
|
|
|
|
#### TriggerOAuthAuthorizeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| authorization_url | string | | Yes |
|
|
| subscription_builder | [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity) | | Yes |
|
|
| subscription_builder_id | string | | Yes |
|
|
|
|
#### TriggerOAuthClientPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| client_params | object | | No |
|
|
| enabled | boolean | | No |
|
|
|
|
#### TriggerOAuthClientResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| configured | boolean | | Yes |
|
|
| custom_configured | boolean | | Yes |
|
|
| custom_enabled | boolean | | Yes |
|
|
| oauth_client_schema | [ [ProviderConfig](#providerconfig) ] | | Yes |
|
|
| params | object | | Yes |
|
|
| redirect_uri | string | | Yes |
|
|
| system_configured | boolean | | Yes |
|
|
|
|
#### TriggerProviderApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the trigger provider | Yes |
|
|
| description | [I18nObject](#i18nobject) | The description of the trigger provider | Yes |
|
|
| events | [ [EventApiEntity](#eventapientity) ] | The events of the trigger provider | Yes |
|
|
| icon | string | The icon of the trigger provider | No |
|
|
| icon_dark | string | The dark icon of the trigger provider | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the trigger provider | Yes |
|
|
| name | string | The name of the trigger provider | Yes |
|
|
| plugin_id | string | The plugin id of the tool | No |
|
|
| plugin_unique_identifier | string | The unique identifier of the tool | No |
|
|
| subscription_constructor | [SubscriptionConstructor](#subscriptionconstructor) | The subscription constructor of the trigger provider | No |
|
|
| subscription_schema | [ [ProviderConfig](#providerconfig) ] | The subscription schema of the trigger provider | No |
|
|
| supported_creation_methods | [ [TriggerCreationMethod](#triggercreationmethod) ] | Supported creation methods for the trigger provider. like 'OAUTH', 'APIKEY', 'MANUAL'. | No |
|
|
| tags | [ string ] | The tags of the trigger provider | No |
|
|
|
|
#### TriggerProviderEntity
|
|
|
|
The configuration of a trigger provider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| events | [ [EventEntity](#evententity) ] | The events of the trigger provider | No |
|
|
| identity | [TriggerProviderIdentity](#triggerprovideridentity) | | Yes |
|
|
| subscription_constructor | [SubscriptionConstructor](#subscriptionconstructor) | The subscription constructor of the trigger provider | No |
|
|
| subscription_schema | [ [ProviderConfig](#providerconfig) ] | The configuration schema stored in the subscription entity | No |
|
|
|
|
#### TriggerProviderErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | Yes |
|
|
|
|
#### TriggerProviderIdentity
|
|
|
|
The identity of the trigger provider
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| author | string | The author of the trigger provider | Yes |
|
|
| description | [I18nObject](#i18nobject) | The description of the trigger provider | Yes |
|
|
| icon | string | The icon of the trigger provider | No |
|
|
| icon_dark | string | The dark icon of the trigger provider | No |
|
|
| label | [I18nObject](#i18nobject) | The label of the trigger provider | Yes |
|
|
| name | string | The name of the trigger provider | Yes |
|
|
| tags | [ string ] | The tags of the trigger provider | No |
|
|
|
|
#### TriggerProviderListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TriggerProviderListResponse | array | | |
|
|
|
|
#### TriggerProviderSubscriptionApiEntity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_type | [CredentialType](#credentialtype) | The type of the credential | Yes |
|
|
| credentials | object | The credentials of the subscription | Yes |
|
|
| endpoint | string | The endpoint of the subscription | Yes |
|
|
| id | string | The unique id of the subscription | Yes |
|
|
| name | string | The name of the subscription | Yes |
|
|
| parameters | object | The parameters of the subscription | Yes |
|
|
| properties | object | The properties of the subscription | Yes |
|
|
| provider | string | The provider id of the subscription | Yes |
|
|
| workflows_in_use | integer | The number of workflows using this subscription | Yes |
|
|
|
|
#### TriggerProviderSubscriptionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TriggerProviderSubscriptionListResponse | array | | |
|
|
|
|
#### TriggerSubscriptionBuilderCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credential_type | string, <br>**Default:** unauthorized | | No |
|
|
|
|
#### TriggerSubscriptionBuilderCreateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| subscription_builder | [SubscriptionBuilderApiEntity](#subscriptionbuilderapientity) | | Yes |
|
|
|
|
#### TriggerSubscriptionBuilderLogsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| logs | [ [RequestLog](#requestlog) ] | | Yes |
|
|
|
|
#### TriggerSubscriptionBuilderUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | No |
|
|
| name | string | | No |
|
|
| parameters | object | | No |
|
|
| properties | object | | No |
|
|
|
|
#### TriggerSubscriptionBuilderVerifyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | No |
|
|
|
|
#### TriggerSubscriptionVerifyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| credentials | object | | Yes |
|
|
|
|
#### TriggerVerificationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| verified | boolean | | Yes |
|
|
|
|
#### TurnstileServiceUnavailableError
|
|
|
|
Turnstile verification is temporarily unavailable. Please try again later.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TurnstileServiceUnavailableError | | Turnstile verification is temporarily unavailable. Please try again later. | |
|
|
|
|
#### TurnstileVerificationFailedError
|
|
|
|
Turnstile verification failed. Please try again.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| TurnstileVerificationFailedError | | Turnstile verification failed. Please try again. | |
|
|
|
|
#### UnaddedModelConfiguration
|
|
|
|
Model class for provider unadded model configuration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| model | string | | Yes |
|
|
| model_type | [ModelType](#modeltype) | | Yes |
|
|
|
|
#### UnchangedInput
|
|
|
|
Retain the addressed saved field; valid only for updates and saved tests.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| type | string | | Yes |
|
|
|
|
#### UnsupportedAudioTypeError
|
|
|
|
Audio type not allowed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| UnsupportedAudioTypeError | | Audio type not allowed. | |
|
|
|
|
#### UnsupportedDataSourceApiKeyAuthProviderError
|
|
|
|
The data-source API-key authentication provider is not supported.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| UnsupportedDataSourceApiKeyAuthProviderError | | The data-source API-key authentication provider is not supported. | |
|
|
|
|
#### UnsupportedFileTypeError
|
|
|
|
File type not allowed.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| UnsupportedFileTypeError | | File type not allowed. | |
|
|
|
|
#### UnsupportedTracingProviderError
|
|
|
|
The tracing provider is not supported.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| UnsupportedTracingProviderError | | The tracing provider is not supported. | |
|
|
|
|
#### UpdateAnnotationPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| annotation_reply | object | | No |
|
|
| answer | string | | No |
|
|
| content | string | | No |
|
|
| question | string | | No |
|
|
|
|
#### UpdateAppPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | App description (max 400 chars) | No |
|
|
| icon | string | Icon | No |
|
|
| icon_background | string | Icon background color | No |
|
|
| icon_type | [IconType](#icontype) | Icon type | No |
|
|
| max_active_requests | integer | Maximum active requests | No |
|
|
| name | string | App name | Yes |
|
|
| use_icon_as_answer_icon | boolean | Use icon as answer icon | No |
|
|
|
|
#### UpdateSnippetPayload
|
|
|
|
Payload for updating a snippet.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| icon_info | [IconInfo](#iconinfo) | | No |
|
|
| name | string | | No |
|
|
|
|
#### UploadConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| attachment_image_file_size_limit | integer | | Yes |
|
|
| audio_file_size_limit | integer | | Yes |
|
|
| batch_count_limit | integer | | Yes |
|
|
| file_size_limit | integer | | Yes |
|
|
| file_upload_limit | integer | | Yes |
|
|
| image_file_batch_limit | integer | | Yes |
|
|
| image_file_size_limit | integer | | Yes |
|
|
| knowledge_file_size_limit | integer | | Yes |
|
|
| single_chunk_attachment_limit | integer | | Yes |
|
|
| skill_file_size_limit | integer | | Yes |
|
|
| video_file_size_limit | integer | | Yes |
|
|
| workflow_file_upload_limit | integer | | Yes |
|
|
|
|
#### UrlQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string (uri) | | Yes |
|
|
|
|
#### UrlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| url | string | | Yes |
|
|
|
|
#### UsageCheckResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| is_using | boolean | | Yes |
|
|
|
|
#### UsageCountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer | | Yes |
|
|
| is_using | boolean | | Yes |
|
|
|
|
#### UserAction
|
|
|
|
Resolved action values required for presentation and submission validation.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| button_style | [ButtonStyle](#buttonstyle) | | Yes |
|
|
| id | string | | Yes |
|
|
| title | string | | Yes |
|
|
|
|
#### UserActionConfig
|
|
|
|
User action configuration.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| button_style | [ButtonStyle](#buttonstyle) | | No |
|
|
| id | string | | Yes |
|
|
| title | string | | Yes |
|
|
|
|
#### UserSatisfactionRateStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| rate | number | | Yes |
|
|
|
|
#### UserSatisfactionRateStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [UserSatisfactionRateStatisticItem](#usersatisfactionratestatisticitem) ] | | Yes |
|
|
|
|
#### ValidationResultResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | No |
|
|
| result | string, <br>**Available values:** "error", "success" | *Enum:* `"error"`, `"success"` | Yes |
|
|
|
|
#### ValueSourceType
|
|
|
|
ValueSourceType records whether the value comes from a static setting
|
|
in form definition, or a variable while the workflow is running.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| ValueSourceType | string | ValueSourceType records whether the value comes from a static setting in form definition, or a variable while the workflow is running. | |
|
|
|
|
#### VectorSpaceLimitationModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer | | Yes |
|
|
| size | integer | | Yes |
|
|
| usage_unknown | boolean | | No |
|
|
|
|
#### VerificationTokenResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | | Yes |
|
|
| is_valid | boolean | | Yes |
|
|
| token | string | | Yes |
|
|
|
|
#### WeComCredentialsInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | WeCom application agent identifier. | Yes |
|
|
| corp_id | string | WeCom corporation identifier. | Yes |
|
|
| provider | string | WeCom credential discriminator. | Yes |
|
|
| secret | [_RequiredSecret](#_requiredsecret) | WeCom application secret. | Yes |
|
|
|
|
#### WeComCredentialsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string | | Yes |
|
|
| corp_id | string | | Yes |
|
|
| provider | string | | Yes |
|
|
| secret | [Redacted](#redacted) | | Yes |
|
|
|
|
#### WeComCredentialsUpdateInput
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_id | string<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| corp_id | [_Identifier](#_identifier)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
| provider | string | | Yes |
|
|
| secret | [_RequiredSecret](#_requiredsecret)<br>[UnchangedInput](#unchangedinput) | | Yes |
|
|
|
|
#### WebAppAccessMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WebAppAccessMode | string | | |
|
|
|
|
#### WebAppAccessUnavailableError
|
|
|
|
The app access service is unavailable. Try again later.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WebAppAccessUnavailableError | | The app access service is unavailable. Try again later. | |
|
|
|
|
#### WebAppAuthModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allow_email_code_login | boolean | | Yes |
|
|
| allow_email_password_login | boolean | | Yes |
|
|
| allow_public_access | boolean, <br>**Default:** true | | Yes |
|
|
| allow_sso | boolean | | Yes |
|
|
| enabled | boolean | | Yes |
|
|
| sso_config | [WebAppAuthSSOModel](#webappauthssomodel) | | Yes |
|
|
|
|
#### WebAppAuthSSOModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| protocol | [SSOProtocol](#ssoprotocol) | | Yes |
|
|
|
|
#### WebhookTriggerNotFoundError
|
|
|
|
Webhook trigger not found for this node.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WebhookTriggerNotFoundError | | Webhook trigger not found for this node. | |
|
|
|
|
#### WebhookTriggerQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_id | string | | Yes |
|
|
|
|
#### WebhookTriggerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | string | | No |
|
|
| id | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| webhook_debug_url | string | | Yes |
|
|
| webhook_id | string | | Yes |
|
|
| webhook_url | string | | Yes |
|
|
|
|
#### WebsiteCrawlPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| options | object | | Yes |
|
|
| provider | string, <br>**Available values:** "firecrawl", "jinareader", "watercrawl" | *Enum:* `"firecrawl"`, `"jinareader"`, `"watercrawl"` | Yes |
|
|
| url | string | | Yes |
|
|
|
|
#### WebsiteCrawlResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WebsiteCrawlResponse | object | | |
|
|
|
|
#### WebsiteCrawlStatusQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| provider | string, <br>**Available values:** "firecrawl", "jinareader", "watercrawl" | *Enum:* `"firecrawl"`, `"jinareader"`, `"watercrawl"` | Yes |
|
|
|
|
#### WebsiteInfo
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| job_id | string | | Yes |
|
|
| only_main_content | boolean, <br>**Default:** true | | No |
|
|
| provider | string | | Yes |
|
|
| urls | [ string ] | | Yes |
|
|
|
|
#### WeightKeywordSetting
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_weight | number | Weight assigned to keyword search results. | Yes |
|
|
|
|
#### WeightModel
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword_setting | [WeightKeywordSetting](#weightkeywordsetting) | Keyword search weight settings. | No |
|
|
| vector_setting | [WeightVectorSetting](#weightvectorsetting) | Semantic search weight settings. | No |
|
|
| weight_type | string, <br>**Available values:** "customized", "keyword_first", "semantic_first" | Strategy for balancing semantic and keyword search weights. | No |
|
|
|
|
#### WeightVectorSetting
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| embedding_model_name | string | Name of the embedding model used for vector search. | Yes |
|
|
| embedding_provider_name | string | Provider of the embedding model used for vector search. | Yes |
|
|
| vector_weight | number | Weight assigned to semantic vector search results. | Yes |
|
|
|
|
#### WorkflowAgentBindingType
|
|
|
|
How a workflow node is bound to an Agent.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowAgentBindingType | string | How a workflow node is bound to an Agent. | |
|
|
|
|
#### WorkflowAgentComposerQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| snapshot_id | string | | No |
|
|
|
|
#### WorkflowAgentComposerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| active_config_snapshot | [AgentConfigSnapshotSummaryResponse](#agentconfigsnapshotsummaryresponse) | | No |
|
|
| agent | [AgentComposerAgentResponse](#agentcomposeragentresponse) | | No |
|
|
| agent_soul | [AgentSoulConfig](#agentsoulconfig) | | Yes |
|
|
| app_id | string | | No |
|
|
| backing_app_id | string | | No |
|
|
| binding | [AgentComposerBindingResponse](#agentcomposerbindingresponse) | | No |
|
|
| chat_endpoint | string | | No |
|
|
| debug_conversation_has_messages | boolean | | No |
|
|
| debug_conversation_id | string | | No |
|
|
| debug_conversation_message_count | integer | | No |
|
|
| effective_declared_outputs | [ [DeclaredOutputConfig](#declaredoutputconfig) ] | | No |
|
|
| hidden_app_backed | boolean | | No |
|
|
| impact_summary | [AgentComposerImpactResponse](#agentcomposerimpactresponse) | | No |
|
|
| node_id | string | | No |
|
|
| node_job | [WorkflowNodeJobConfig](#workflownodejobconfig) | | Yes |
|
|
| save_options | [ [ComposerSaveStrategy](#composersavestrategy) ] | | Yes |
|
|
| soul_lock | [AgentComposerSoulLockResponse](#agentcomposersoullockresponse) | | Yes |
|
|
| validation | [ComposerValidationFindingsResponse](#composervalidationfindingsresponse) | | No |
|
|
| variant | string | | Yes |
|
|
| workflow_id | string | | No |
|
|
|
|
#### WorkflowAgentSandboxDownloadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_execution_id | string | Workflow node execution ID | Yes |
|
|
| path | string | Binding path: relative paths start in Workspace; exact `~` and paths beginning with `~/` start in Home; `~user` is an ordinary relative path from Workspace; absolute paths remain absolute; `..` and paths outside Workspace are governed by backend isolation, not a Workspace-root restriction | Yes |
|
|
|
|
#### WorkflowAppBlockingResponse
|
|
|
|
WorkflowAppBlockingResponse entity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [WorkflowAppBlockingResponseData](#workflowappblockingresponsedata) | | Yes |
|
|
| task_id | string | | Yes |
|
|
| workflow_run_id | string | | Yes |
|
|
|
|
#### WorkflowAppBlockingResponseData
|
|
|
|
Data entity
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| elapsed_time | number | | Yes |
|
|
| error | string | | No |
|
|
| finished_at | integer | | Yes |
|
|
| id | string | | Yes |
|
|
| outputs | object | | No |
|
|
| status | [WorkflowExecutionStatus](#workflowexecutionstatus) | | Yes |
|
|
| total_steps | integer | | Yes |
|
|
| total_tokens | integer | | Yes |
|
|
| workflow_id | string | | Yes |
|
|
|
|
#### WorkflowAppLogPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowAppLogPartialResponse](#workflowapplogpartialresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### WorkflowAppLogPartialResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
|
|
| created_by_role | string | | No |
|
|
| created_from | string | | No |
|
|
| details | | | No |
|
|
| id | string | | Yes |
|
|
| workflow_run | [WorkflowRunForLogResponse](#workflowrunforlogresponse) | | No |
|
|
|
|
#### WorkflowAppLogQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at__after | string | Filter logs created after this timestamp | No |
|
|
| created_at__before | string | Filter logs created before this timestamp | No |
|
|
| created_by_account | string | Filter by account | No |
|
|
| created_by_end_user_session_id | string | Filter by end user session ID | No |
|
|
| detail | boolean | Whether to return detailed logs | No |
|
|
| keyword | string | Search keyword for filtering logs | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of items per page (1-100) | No |
|
|
| page | integer, <br>**Default:** 1 | Page number (1-99999) | No |
|
|
| status | [WorkflowExecutionStatus](#workflowexecutionstatus) | Execution status filter | No |
|
|
|
|
#### WorkflowAverageAppInteractionStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| interactions | number | | Yes |
|
|
|
|
#### WorkflowAverageAppInteractionStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowAverageAppInteractionStatisticItem](#workflowaverageappinteractionstatisticitem) ] | | Yes |
|
|
|
|
#### WorkflowCommentAccount
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar_url | string | | Yes |
|
|
| email | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
|
|
#### WorkflowCommentBasic
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | Yes |
|
|
| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
|
|
| id | string | | Yes |
|
|
| mention_count | integer | | Yes |
|
|
| participants | [ [WorkflowCommentAccount](#workflowcommentaccount) ] | | Yes |
|
|
| position_x | number | | Yes |
|
|
| position_y | number | | Yes |
|
|
| reply_count | integer | | Yes |
|
|
| resolved | boolean | | Yes |
|
|
| resolved_at | integer | | No |
|
|
| resolved_by | string | | No |
|
|
| resolved_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
|
|
| updated_at | integer | | No |
|
|
|
|
#### WorkflowCommentBasicList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowCommentBasic](#workflowcommentbasic) ] | | Yes |
|
|
|
|
#### WorkflowCommentCreate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
|
|
#### WorkflowCommentCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Comment content | Yes |
|
|
| mentioned_user_ids | [ string ] | Mentioned user IDs | No |
|
|
| position_x | number | Comment X position | Yes |
|
|
| position_y | number | Comment Y position | Yes |
|
|
|
|
#### WorkflowCommentDetail
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | Yes |
|
|
| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
|
|
| id | string | | Yes |
|
|
| mentions | [ [WorkflowCommentMention](#workflowcommentmention) ] | | Yes |
|
|
| position_x | number | | Yes |
|
|
| position_y | number | | Yes |
|
|
| replies | [ [WorkflowCommentReply](#workflowcommentreply) ] | | Yes |
|
|
| resolved | boolean | | Yes |
|
|
| resolved_at | integer | | No |
|
|
| resolved_by | string | | No |
|
|
| resolved_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
|
|
| updated_at | integer | | No |
|
|
|
|
#### WorkflowCommentMention
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| mentioned_user_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
|
|
| mentioned_user_id | string | | Yes |
|
|
| reply_id | string | | No |
|
|
|
|
#### WorkflowCommentMentionUsersPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| users | [ [AccountWithRoleResponse](#accountwithroleresponse) ] | | Yes |
|
|
|
|
#### WorkflowCommentReply
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | | Yes |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | Yes |
|
|
| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
|
|
| id | string | | Yes |
|
|
|
|
#### WorkflowCommentReplyCreate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
|
|
#### WorkflowCommentReplyPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Reply content | Yes |
|
|
| mentioned_user_ids | [ string ] | Mentioned user IDs | No |
|
|
|
|
#### WorkflowCommentReplyUpdate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
|
|
#### WorkflowCommentResolve
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| resolved | boolean | | Yes |
|
|
| resolved_at | integer | | No |
|
|
| resolved_by | string | | No |
|
|
|
|
#### WorkflowCommentUpdate
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
|
|
#### WorkflowCommentUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| content | string | Comment content | Yes |
|
|
| mentioned_user_ids | [ string ] | Mentioned user IDs. Omit to keep existing mentions. | No |
|
|
| position_x | number | Comment X position | No |
|
|
| position_y | number | Comment Y position | No |
|
|
|
|
#### WorkflowComposerCopyFromRosterPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| idempotency_key | string | | No |
|
|
| source_agent_id | string | | Yes |
|
|
| source_snapshot_id | string | | No |
|
|
|
|
#### WorkflowConversationVariableResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| value | | | Yes |
|
|
| value_type | string | | Yes |
|
|
|
|
#### WorkflowDailyRunsStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| runs | integer | | Yes |
|
|
|
|
#### WorkflowDailyRunsStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowDailyRunsStatisticItem](#workflowdailyrunsstatisticitem) ] | | Yes |
|
|
|
|
#### WorkflowDailyTerminalsStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| terminal_count | integer | | Yes |
|
|
|
|
#### WorkflowDailyTerminalsStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowDailyTerminalsStatisticItem](#workflowdailyterminalsstatisticitem) ] | | Yes |
|
|
|
|
#### WorkflowDailyTokenCostStatisticItem
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| date | string | | Yes |
|
|
| token_count | integer | | Yes |
|
|
|
|
#### WorkflowDailyTokenCostStatisticResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowDailyTokenCostStatisticItem](#workflowdailytokencoststatisticitem) ] | | Yes |
|
|
|
|
#### WorkflowDraftVariableFullContentResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| download_url | string | | Yes |
|
|
| length | integer | | Yes |
|
|
| size_bytes | integer | | Yes |
|
|
| value_type | string | | Yes |
|
|
|
|
#### WorkflowDraftVariableListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 20 | Items per page | No |
|
|
| page | integer, <br>**Default:** 1 | Page number | No |
|
|
|
|
#### WorkflowDraftVariableListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [WorkflowDraftVariableResponse](#workflowdraftvariableresponse) ] | | Yes |
|
|
|
|
#### WorkflowDraftVariableListWithoutValueResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [WorkflowDraftVariableWithoutValueResponse](#workflowdraftvariablewithoutvalueresponse) ] | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### WorkflowDraftVariablePatchPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | No |
|
|
| value | | | No |
|
|
|
|
#### WorkflowDraftVariableResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| edited | boolean | | Yes |
|
|
| full_content | [WorkflowDraftVariableFullContentResponse](#workflowdraftvariablefullcontentresponse) | | Yes |
|
|
| id | string | | Yes |
|
|
| is_truncated | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| selector | [ string ] | | Yes |
|
|
| type | string | | Yes |
|
|
| value | [RecursiveJSONValue](#recursivejsonvalue) | | Yes |
|
|
| value_type | string | | Yes |
|
|
| visible | boolean | | Yes |
|
|
|
|
#### WorkflowDraftVariableUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | Variable name | No |
|
|
| value | | Variable value | No |
|
|
|
|
#### WorkflowDraftVariableWithoutValueResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| edited | boolean | | Yes |
|
|
| id | string | | Yes |
|
|
| is_truncated | boolean | | Yes |
|
|
| name | string | | Yes |
|
|
| selector | [ string ] | | Yes |
|
|
| type | string | | Yes |
|
|
| value_type | string | | Yes |
|
|
| visible | boolean | | Yes |
|
|
|
|
#### WorkflowEnvironmentVariableResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| id | string | | Yes |
|
|
| name | string | | Yes |
|
|
| value | | | Yes |
|
|
| value_type | string | | Yes |
|
|
|
|
#### WorkflowExecutionStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowExecutionStatus | string | | |
|
|
|
|
#### WorkflowFeatureTogglePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
|
|
#### WorkflowFeaturesConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_upload | [WorkflowFileUploadPayload](#workflowfileuploadpayload) | | No |
|
|
| opening_statement | string | | No |
|
|
| retriever_resource | [WorkflowFeatureTogglePayload](#workflowfeaturetogglepayload) | | No |
|
|
| sensitive_word_avoidance | [WorkflowSensitiveWordAvoidancePayload](#workflowsensitivewordavoidancepayload) | | No |
|
|
| speech_to_text | [WorkflowFeatureTogglePayload](#workflowfeaturetogglepayload) | | No |
|
|
| suggested_questions | [ string ] | | No |
|
|
| suggested_questions_after_answer | [WorkflowSuggestedQuestionsAfterAnswerPayload](#workflowsuggestedquestionsafteranswerpayload) | | No |
|
|
| text_to_speech | [WorkflowTextToSpeechPayload](#workflowtexttospeechpayload) | | No |
|
|
|
|
#### WorkflowFeaturesPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| features | [WorkflowFeaturesConfigPayload](#workflowfeaturesconfigpayload) | Workflow feature configuration | Yes |
|
|
|
|
#### WorkflowFileUploadImagePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| detail | string | | No |
|
|
| enabled | boolean | | No |
|
|
| number_limits | integer | | No |
|
|
| transfer_methods | [ string ] | | No |
|
|
|
|
#### WorkflowFileUploadPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allowed_file_extensions | [ string ] | | No |
|
|
| allowed_file_types | [ string ] | | No |
|
|
| allowed_file_upload_methods | [ string ] | | No |
|
|
| audio | [WorkflowFileUploadTransferPayload](#workflowfileuploadtransferpayload) | | No |
|
|
| custom | [WorkflowFileUploadTransferPayload](#workflowfileuploadtransferpayload) | | No |
|
|
| document | [WorkflowFileUploadTransferPayload](#workflowfileuploadtransferpayload) | | No |
|
|
| enabled | boolean | | No |
|
|
| fileUploadConfig | object | | No |
|
|
| image | [WorkflowFileUploadImagePayload](#workflowfileuploadimagepayload) | | No |
|
|
| number_limits | integer | | No |
|
|
| preview_config | [WorkflowFileUploadPreviewConfigPayload](#workflowfileuploadpreviewconfigpayload) | | No |
|
|
| video | [WorkflowFileUploadTransferPayload](#workflowfileuploadtransferpayload) | | No |
|
|
|
|
#### WorkflowFileUploadPreviewConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| file_type_list | [ string ] | | No |
|
|
| mode | string | | No |
|
|
|
|
#### WorkflowFileUploadTransferPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| number_limits | integer | | No |
|
|
| transfer_methods | [ string ] | | No |
|
|
|
|
#### WorkflowGenerateErrorCode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowGenerateErrorCode | string | | |
|
|
|
|
#### WorkflowGenerateErrorResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| code | [WorkflowGenerateErrorCode](#workflowgenerateerrorcode) | | Yes |
|
|
| detail | string | | Yes |
|
|
| node_id | string | | No |
|
|
|
|
#### WorkflowGeneratePayload
|
|
|
|
Payload for the cmd+k `/create` and `/refine` workflow generator endpoint.
|
|
|
|
See ``services/workflow_generator_service.py`` for behaviour. Errors are
|
|
surfaced through the same envelope as ``/rule-generate`` so the frontend
|
|
can reuse its existing handler.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| current_graph | [WorkflowGraph](#workflowgraph) | Existing draft graph to refine (cmd+k `/refine`); omit for create-from-scratch | No |
|
|
| ideal_output | string | Optional sample output for grounding | No |
|
|
| instruction | string | Natural-language workflow description | Yes |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "auto", "workflow" | Target app mode for the generated graph; 'auto' lets the backend classify the instruction<br>*Enum:* `"advanced-chat"`, `"auto"`, `"workflow"` | Yes |
|
|
| model_config | [ModelConfig](#modelconfig) | Model configuration | Yes |
|
|
|
|
#### WorkflowGeneratePlanEventResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_name | string | | No |
|
|
| description | string | | No |
|
|
| event | string | | No |
|
|
| icon | string | | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "workflow" | *Enum:* `"advanced-chat"`, `"workflow"` | Yes |
|
|
| nodes | [ [WorkflowPlanNodeResponse](#workflowplannoderesponse) ] | | Yes |
|
|
| start_inputs | [ [WorkflowPlanStartInputResponse](#workflowplanstartinputresponse) ] | | No |
|
|
| title | string | | No |
|
|
|
|
#### WorkflowGenerateRejectedResponse
|
|
|
|
400 body when the boundary guard rejects the instruction before generating.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | Yes |
|
|
| errors | [ [WorkflowGenerateErrorResponse](#workflowgenerateerrorresponse) ] | | Yes |
|
|
|
|
#### WorkflowGenerateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_name | string | | No |
|
|
| error | string | | No |
|
|
| errors | [ [WorkflowGenerateErrorResponse](#workflowgenerateerrorresponse) ] | | No |
|
|
| graph | [WorkflowGraph](#workflowgraph) | | Yes |
|
|
| icon | string | | No |
|
|
| message | string | | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "workflow" | | No |
|
|
|
|
#### WorkflowGenerateResultEventResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_name | string | | No |
|
|
| error | string | | No |
|
|
| errors | [ [WorkflowGenerateErrorResponse](#workflowgenerateerrorresponse) ] | | No |
|
|
| event | string | | No |
|
|
| graph | [WorkflowGraph](#workflowgraph) | | Yes |
|
|
| icon | string | | No |
|
|
| message | string | | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "workflow" | | No |
|
|
|
|
#### WorkflowGenerateStreamEventResponse
|
|
|
|
Schema for each JSON object carried by an SSE ``data:`` frame.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowGenerateStreamEventResponse | [WorkflowGeneratePlanEventResponse](#workflowgenerateplaneventresponse)<br>[WorkflowGenerateResultEventResponse](#workflowgenerateresulteventresponse) | Schema for each JSON object carried by an SSE ``data:`` frame. | |
|
|
|
|
#### WorkflowGraph
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| edges | [ [WorkflowGraphEdge](#workflowgraphedge) ] | | Yes |
|
|
| nodes | [ [WorkflowGraphNode](#workflowgraphnode) ] | | Yes |
|
|
| viewport | [WorkflowGraphViewport](#workflowgraphviewport) | | Yes |
|
|
|
|
#### WorkflowGraphEdge
|
|
|
|
React Flow edge shape with extensible renderer metadata.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| source | string | | Yes |
|
|
| target | string | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### WorkflowGraphNode
|
|
|
|
React Flow node shape accepted and returned by the generator.
|
|
|
|
Node-specific configuration lives under ``data`` and wrapper metadata
|
|
differs for container children, so unknown wrapper fields must survive
|
|
request validation and response serialization.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | object | | Yes |
|
|
| id | string | | Yes |
|
|
| position | [WorkflowGraphPosition](#workflowgraphposition) | | Yes |
|
|
| type | string | | Yes |
|
|
|
|
#### WorkflowGraphPosition
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| x | number | | Yes |
|
|
| y | number | | Yes |
|
|
|
|
#### WorkflowGraphViewport
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| x | number | | Yes |
|
|
| y | number | | Yes |
|
|
| zoom | number | | Yes |
|
|
|
|
#### WorkflowInstructionSuggestionsPayload
|
|
|
|
Payload for the workflow-generator instruction-suggestions endpoint.
|
|
|
|
Runs before the user picks a model, so the suggestions come from the
|
|
tenant's default model. The underlying generator never raises — an empty
|
|
``suggestions`` list is a valid 200 (soft-fail).
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| count | integer, <br>**Default:** 4 | Number of suggestions to return (1-6) | No |
|
|
| language | string | Optional language to write the suggestions in | No |
|
|
| mode | string, <br>**Available values:** "advanced-chat", "workflow" | Target app mode for the suggestions<br>*Enum:* `"advanced-chat"`, `"workflow"` | Yes |
|
|
|
|
#### WorkflowInstructionSuggestionsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| suggestions | [ string ] | | Yes |
|
|
|
|
#### WorkflowListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 10 | | No |
|
|
| named_only | boolean | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
| user_id | string | | No |
|
|
|
|
#### WorkflowNodeJobConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| declared_outputs | [ [DeclaredOutputConfig](#declaredoutputconfig) ] | | No |
|
|
| human_contacts | [ [AgentHumanContactConfig](#agenthumancontactconfig) ] | | No |
|
|
| metadata | [WorkflowNodeJobMetadata](#workflownodejobmetadata) | | No |
|
|
| mode | [WorkflowNodeJobMode](#workflownodejobmode) | | No |
|
|
| output_routes | [WorkflowOutputRoutes](#workflowoutputroutes) | | No |
|
|
| previous_node_output_refs | [ [WorkflowPreviousNodeOutputRef](#workflowpreviousnodeoutputref) ] | | No |
|
|
| schema_version | integer, <br>**Default:** 1 | | No |
|
|
| workflow_prompt | string | | No |
|
|
|
|
#### WorkflowNodeJobMetadata
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| agent_soul | object | | No |
|
|
| file_refs | [ [AgentFileRefConfig](#agentfilerefconfig) ] | | No |
|
|
|
|
#### WorkflowNodeJobMode
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowNodeJobMode | string | | |
|
|
|
|
#### WorkflowNotActiveError
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowNotActiveError | | | |
|
|
|
|
#### WorkflowOnlineUser
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| avatar | string | | No |
|
|
| user_id | string | | Yes |
|
|
| username | string | | Yes |
|
|
|
|
#### WorkflowOnlineUsersByApp
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_id | string | | Yes |
|
|
| users | [ [WorkflowOnlineUser](#workflowonlineuser) ] | | Yes |
|
|
|
|
#### WorkflowOnlineUsersPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| app_ids | [ string ] | App IDs | No |
|
|
|
|
#### WorkflowOnlineUsersResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowOnlineUsersByApp](#workflowonlineusersbyapp) ] | | Yes |
|
|
|
|
#### WorkflowOutputRoute
|
|
|
|
Stable workflow exit identity and its model-visible selection condition.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
| label | string | | No |
|
|
| name | string | | No |
|
|
|
|
#### WorkflowOutputRoutes
|
|
|
|
Enabled routes require at least two exits; drafts may omit conditions.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| routes | [ [WorkflowOutputRoute](#workflowoutputroute) ] | | No |
|
|
|
|
#### WorkflowPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| has_more | boolean | | Yes |
|
|
| items | [ [WorkflowResponse](#workflowresponse) ] | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
|
|
#### WorkflowPartial
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by | string | | No |
|
|
| id | string | | Yes |
|
|
| updated_at | integer | | No |
|
|
| updated_by | string | | No |
|
|
|
|
#### WorkflowPauseDetailsResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| paused_at | string | | No |
|
|
| paused_nodes | [ [PausedNodeResponse](#pausednoderesponse) ] | | Yes |
|
|
|
|
#### WorkflowPlanNodeResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | string | | Yes |
|
|
| node_type | string | | Yes |
|
|
| purpose | string | | No |
|
|
|
|
#### WorkflowPlanStartInputResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| label | string | | No |
|
|
| type | string | | No |
|
|
| variable | string | | Yes |
|
|
|
|
#### WorkflowPreviousNodeOutputRef
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| key | string | | No |
|
|
| name | string | | No |
|
|
| node_id | string | | No |
|
|
| output | string | | No |
|
|
| selector | [ string<br>integer<br>number<br>boolean ] | | No |
|
|
| value_selector | [ string<br>integer<br>number<br>boolean ] | | No |
|
|
| variable | string | | No |
|
|
| variable_selector | [ string<br>integer<br>number<br>boolean ] | | No |
|
|
|
|
#### WorkflowPublishResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | Yes |
|
|
| result | string | | Yes |
|
|
| warning | string | Advisory warning for variable references that can read a skipped branch. Publish still succeeds. | No |
|
|
|
|
#### WorkflowResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| conversation_variables | [ [WorkflowConversationVariableResponse](#workflowconversationvariableresponse) ] | | Yes |
|
|
| created_at | integer | | Yes |
|
|
| created_by | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| environment_variables | [ [WorkflowEnvironmentVariableResponse](#workflowenvironmentvariableresponse) ] | | Yes |
|
|
| features | object | | Yes |
|
|
| graph | object | | Yes |
|
|
| hash | string | | Yes |
|
|
| id | string | | Yes |
|
|
| marked_comment | string | | Yes |
|
|
| marked_name | string | | Yes |
|
|
| rag_pipeline_variables | [ [PipelineVariableResponse](#pipelinevariableresponse) ] | | Yes |
|
|
| tool_published | boolean | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
| updated_by | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| version | string | | Yes |
|
|
| version_number | integer | | No |
|
|
|
|
#### WorkflowRestoreResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| hash | string | | Yes |
|
|
| result | string | | Yes |
|
|
| updated_at | integer | | Yes |
|
|
|
|
#### WorkflowRunArchiveDeletionStatus
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowRunArchiveDeletionStatus | string | | |
|
|
|
|
#### WorkflowRunArchiveDeletionTaskResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | No |
|
|
| month | integer | | Yes |
|
|
| status | [WorkflowRunArchiveDeletionStatus](#workflowrunarchivedeletionstatus) | | Yes |
|
|
| year | integer | | Yes |
|
|
|
|
#### WorkflowRunArchiveDownloadPayload
|
|
|
|
Request body for preparing one monthly workflow-run archive download.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| month | integer | | Yes |
|
|
| year | integer | | Yes |
|
|
|
|
#### WorkflowRunArchiveDownloadStatus
|
|
|
|
Lifecycle state for an asynchronous archive download request.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowRunArchiveDownloadStatus | string | Lifecycle state for an asynchronous archive download request. | |
|
|
|
|
#### WorkflowRunArchiveDownloadTaskResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archive_bytes | integer | | Yes |
|
|
| bundle_count | integer | | Yes |
|
|
| created_at | dateTime | | Yes |
|
|
| download_id | string | | Yes |
|
|
| error | string | | No |
|
|
| expires_at | dateTime | | Yes |
|
|
| file_name | string | | No |
|
|
| file_size_bytes | integer | | No |
|
|
| finished_at | string | | No |
|
|
| month | integer | | Yes |
|
|
| started_at | string | | No |
|
|
| status | [WorkflowRunArchiveDownloadStatus](#workflowrunarchivedownloadstatus) | | Yes |
|
|
| updated_at | dateTime | | Yes |
|
|
| year | integer | | Yes |
|
|
|
|
#### WorkflowRunArchiveListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| months | [ [WorkflowRunArchiveMonthResponse](#workflowrunarchivemonthresponse) ] | | Yes |
|
|
| summary | [WorkflowRunArchiveSummaryResponse](#workflowrunarchivesummaryresponse) | | Yes |
|
|
|
|
#### WorkflowRunArchiveMonthResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archive_bytes | integer | | Yes |
|
|
| bundle_count | integer | | Yes |
|
|
| deletion_status | string, <br>**Available values:** "failed", "pending", "processing" | | No |
|
|
| download_task | [WorkflowRunArchiveDownloadTaskResponse](#workflowrunarchivedownloadtaskresponse) | | No |
|
|
| latest_archived_at | dateTime | | Yes |
|
|
| month | integer | | Yes |
|
|
| row_count | integer | | Yes |
|
|
| workflow_run_count | integer | | Yes |
|
|
| year | integer | | Yes |
|
|
|
|
#### WorkflowRunArchiveSummaryResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| archive_bytes | integer | | Yes |
|
|
| archived_month_count | integer | | Yes |
|
|
| latest_archived_at | string | | No |
|
|
| workflow_run_count | integer | | Yes |
|
|
|
|
#### WorkflowRunCountQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| status | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" | Workflow run status filter | No |
|
|
| time_range | string | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No |
|
|
| triggered_from | string, <br>**Available values:** "app-run", "debugging" | Filter by trigger source: debugging or app-run. Default: debugging | No |
|
|
|
|
#### WorkflowRunCountResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| failed | integer | | Yes |
|
|
| partial_succeeded | integer | | Yes |
|
|
| running | integer | | Yes |
|
|
| stopped | integer | | Yes |
|
|
| succeeded | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### WorkflowRunDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
|
|
| created_by_role | string | | No |
|
|
| elapsed_time | number | | No |
|
|
| error | string | | No |
|
|
| exceptions_count | integer | | No |
|
|
| finished_at | integer | | No |
|
|
| graph | | | Yes |
|
|
| id | string | | Yes |
|
|
| inputs | | | Yes |
|
|
| outputs | | | Yes |
|
|
| status | string | | No |
|
|
| total_steps | integer | | No |
|
|
| total_tokens | integer | | No |
|
|
| version | string | | No |
|
|
|
|
#### WorkflowRunForListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| elapsed_time | number | | No |
|
|
| exceptions_count | integer | | No |
|
|
| finished_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| retry_index | integer | | No |
|
|
| status | string | | No |
|
|
| total_steps | integer | | No |
|
|
| total_tokens | integer | | No |
|
|
| version | string | | No |
|
|
|
|
#### WorkflowRunForLogResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| elapsed_time | number | | No |
|
|
| error | string | | No |
|
|
| exceptions_count | integer | | No |
|
|
| finished_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| status | string | | No |
|
|
| total_steps | integer | | No |
|
|
| total_tokens | integer | | No |
|
|
| triggered_from | string | | No |
|
|
| version | string | | No |
|
|
|
|
#### WorkflowRunListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| last_id | string | Last run ID for pagination | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of items per page (1-100) | No |
|
|
| status | string, <br>**Available values:** "failed", "partial-succeeded", "running", "stopped", "succeeded" | Workflow run status filter | No |
|
|
| triggered_from | string, <br>**Available values:** "app-run", "debugging" | Filter by trigger source: debugging or app-run. Default: debugging | No |
|
|
|
|
#### WorkflowRunNodeExecutionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowRunNodeExecutionResponse](#workflowrunnodeexecutionresponse) ] | | Yes |
|
|
|
|
#### WorkflowRunNodeExecutionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
|
|
| created_by_role | string | | No |
|
|
| elapsed_time | number | | No |
|
|
| error | string | | No |
|
|
| execution_metadata | | | No |
|
|
| extras | | | No |
|
|
| finished_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| index | integer | | No |
|
|
| inputs | | | No |
|
|
| inputs_truncated | boolean | | No |
|
|
| node_id | string | | No |
|
|
| node_type | string | | No |
|
|
| outputs | | | No |
|
|
| outputs_truncated | boolean | | No |
|
|
| predecessor_node_id | string | | No |
|
|
| process_data | | | No |
|
|
| process_data_truncated | boolean | | No |
|
|
| retry_index | integer | | No |
|
|
| status | string | | No |
|
|
| title | string | | No |
|
|
|
|
#### WorkflowRunNotFoundError
|
|
|
|
Workflow run not found.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| WorkflowRunNotFoundError | | Workflow run not found. | |
|
|
|
|
#### WorkflowRunPaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowRunForListResponse](#workflowrunforlistresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
|
|
#### WorkflowRunPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object<br>object<br>object<br>object ] | File list for workflow system file inputs. Available when file upload is enabled for the workflow. To attach a local file, first upload it via [Upload File](/api-reference/files/upload-file) and use the returned `id` as `upload_file_id` with `transfer_method: local_file`. | No |
|
|
| inputs | object | Key-value pairs for workflow input variables. Values for file-type variables should be arrays of file objects with `type`, `transfer_method`, and either `url` or `upload_file_id`. Refer to the `user_input_form` field in the [Get App Parameters](/api-reference/applications/get-app-parameters) response to discover the variable names and types expected by your app. | Yes |
|
|
|
|
#### WorkflowRunRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| files | [ object ] | | No |
|
|
| inputs | object | | Yes |
|
|
|
|
#### WorkflowRunSnapshotView
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| node_outputs | [ [NodeOutputsView](#nodeoutputsview) ] | | No |
|
|
| workflow_run_id | string | | Yes |
|
|
| workflow_run_status | [WorkflowExecutionStatus](#workflowexecutionstatus) | | Yes |
|
|
|
|
#### WorkflowSensitiveWordAvoidancePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| config | object | | No |
|
|
| enabled | boolean | | No |
|
|
| type | string | | No |
|
|
|
|
#### WorkflowStatisticQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| end | string | End date and time (YYYY-MM-DD HH:MM) | No |
|
|
| start | string | Start date and time (YYYY-MM-DD HH:MM) | No |
|
|
|
|
#### WorkflowSuggestedQuestionsAfterAnswerPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| enabled | boolean | | No |
|
|
| model | object | | No |
|
|
| prompt | string | | No |
|
|
|
|
#### WorkflowTextToSpeechPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| autoPlay | string, <br>**Available values:** "disabled", "enabled" | | No |
|
|
| enabled | boolean | | No |
|
|
| language | string | | No |
|
|
| voice | string | | No |
|
|
|
|
#### WorkflowToolCreatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
|
|
| label | string | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| name | string | | Yes |
|
|
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] | | No |
|
|
| privacy_policy | string | | No |
|
|
| workflow_app_id | string | | Yes |
|
|
|
|
#### WorkflowToolDeletePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| workflow_tool_id | string | | Yes |
|
|
|
|
#### WorkflowToolDetailResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
|
|
| label | string | | Yes |
|
|
| name | string | | Yes |
|
|
| output_schema | object | | No |
|
|
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] | | Yes |
|
|
| privacy_policy | string | | No |
|
|
| synced | boolean | | Yes |
|
|
| tool | [ToolApiEntity](#toolapientity) | | Yes |
|
|
| workflow_app_id | string | | Yes |
|
|
| workflow_tool_id | string | | Yes |
|
|
|
|
#### WorkflowToolGetQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| workflow_app_id | string | | No |
|
|
| workflow_tool_id | string | | No |
|
|
|
|
#### WorkflowToolListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| workflow_tool_id | string | | Yes |
|
|
|
|
#### WorkflowToolNodeExecutionListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowToolNodeExecutionResponse](#workflowtoolnodeexecutionresponse) ] | | Yes |
|
|
|
|
#### WorkflowToolNodeExecutionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| created_by_account | [SimpleAccountResponse](#simpleaccountresponse) | | No |
|
|
| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
|
|
| created_by_role | string | | No |
|
|
| elapsed_time | number | | No |
|
|
| error | string | | No |
|
|
| execution_metadata | | | No |
|
|
| extras | | | No |
|
|
| finished_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| index | integer | | No |
|
|
| inputs | | | No |
|
|
| inputs_truncated | boolean | | No |
|
|
| node_execution_id | string | | No |
|
|
| node_id | string | | No |
|
|
| node_type | string | | No |
|
|
| outputs | | | No |
|
|
| outputs_truncated | boolean | | No |
|
|
| predecessor_node_id | string | | No |
|
|
| process_data | | | No |
|
|
| process_data_truncated | boolean | | No |
|
|
| retry_index | integer | | No |
|
|
| status | string | | No |
|
|
| title | string | | No |
|
|
|
|
#### WorkflowToolParameterConfiguration
|
|
|
|
Workflow tool configuration
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | The description of the parameter | Yes |
|
|
| form | [ToolParameterForm](#toolparameterform) | The form of the parameter | Yes |
|
|
| name | string | The name of the parameter | Yes |
|
|
|
|
#### WorkflowToolUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | Yes |
|
|
| icon | [ToolEmojiIcon](#toolemojiicon) | | Yes |
|
|
| label | string | | Yes |
|
|
| labels | [ string ] | | No |
|
|
| name | string | | Yes |
|
|
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] | | No |
|
|
| privacy_policy | string | | No |
|
|
| workflow_tool_id | string | | Yes |
|
|
|
|
#### WorkflowTriggerListResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkflowTriggerResponse](#workflowtriggerresponse) ] | | Yes |
|
|
|
|
#### WorkflowTriggerResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | string | | No |
|
|
| icon | string | | Yes |
|
|
| id | string | | Yes |
|
|
| node_id | string | | Yes |
|
|
| provider_name | string | | Yes |
|
|
| status | string | | Yes |
|
|
| title | string | | Yes |
|
|
| trigger_type | string | | Yes |
|
|
| updated_at | string | | No |
|
|
|
|
#### WorkflowTriggerRunErrorResponse
|
|
|
|
400 body when a draft trigger run fails; ``error`` is omitted when there is nothing user-facing to say.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | string | | No |
|
|
| status | string | | Yes |
|
|
|
|
#### WorkflowUpdatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| marked_comment | string | | No |
|
|
| marked_name | string | | No |
|
|
|
|
#### WorkspaceAccessMatrix
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| items | [ [AccessMatrixItem](#accessmatrixitem) ] | | No |
|
|
| pagination | [Pagination](#pagination) | | No |
|
|
|
|
#### WorkspaceCustomConfigPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| remove_webapp_brand | boolean | | No |
|
|
| replace_webapp_logo | string | | No |
|
|
|
|
#### WorkspaceCustomConfigResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| remove_webapp_brand | boolean | | No |
|
|
| replace_webapp_logo | string | | No |
|
|
|
|
#### WorkspaceInfoPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| name | string | | Yes |
|
|
|
|
#### WorkspaceListItemResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| created_at | integer | | No |
|
|
| id | string | | Yes |
|
|
| name | string | | No |
|
|
| status | string | | No |
|
|
|
|
#### WorkspaceListQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| limit | integer, <br>**Default:** 20 | | No |
|
|
| page | integer, <br>**Default:** 1 | | No |
|
|
|
|
#### WorkspaceLogoUploadResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| id | string | | Yes |
|
|
|
|
#### WorkspacePaginationResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [WorkspaceListItemResponse](#workspacelistitemresponse) ] | | Yes |
|
|
| has_more | boolean | | Yes |
|
|
| limit | integer | | Yes |
|
|
| page | integer | | Yes |
|
|
| total | integer | | Yes |
|
|
|
|
#### WorkspacePermissionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| allow_member_invite | boolean | | Yes |
|
|
| allow_owner_transfer | boolean | | Yes |
|
|
| workspace_id | string | | Yes |
|
|
|
|
#### WorkspacePermissionSnapshot
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| permission_keys | [ string ] | | No |
|
|
|
|
#### WorkspaceSkillsQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| keyword | string | Search keyword matching skill name or description. | No |
|
|
| limit | integer, <br>**Default:** 20 | Number of items per page. | No |
|
|
| page | integer, <br>**Default:** 1 | Page number. | No |
|
|
| tag | [ string ] | Skill tag filters. Repeat the parameter for multiple tags. | No |
|
|
|
|
#### WorkspaceTenantResultResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | | Yes |
|
|
| tenant | [TenantInfoResponse](#tenantinforesponse) | | Yes |
|
|
|
|
#### _AccessControlLanguageQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Available values:** "en", "ja", "zh" | Localized policy label language | No |
|
|
|
|
#### _AccessPolicyCreateRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ], <br>**Default:** | | No |
|
|
| resource_type | [RBACResourceType](#rbacresourcetype) | | Yes |
|
|
|
|
#### _AccessPolicyList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [AccessPolicy](#accesspolicy) ] | | No |
|
|
| pagination | [Pagination](#pagination) | | No |
|
|
|
|
#### _AccessPolicyUpdateRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ], <br>**Default:** | | No |
|
|
|
|
#### _DeleteMemberBindingsRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_ids | [ string ] | | No |
|
|
|
|
#### _Identifier
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| _Identifier | string | | |
|
|
|
|
#### _InteractiveSurfaceDeliveryConfig
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
|
|
#### _MembersInRoleList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [MembersInRole](#membersinrole) ] | | No |
|
|
| pagination | [Pagination](#pagination) | | No |
|
|
|
|
#### _OptionalSecret
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| _OptionalSecret | string | | |
|
|
|
|
#### _RBACRoleList
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| data | [ [RBACRole](#rbacrole) ] | | No |
|
|
| pagination | [Pagination](#pagination) | | No |
|
|
|
|
#### _ReplaceBindingsRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| account_ids | [ string ] | | No |
|
|
| role_ids | [ string ] | | No |
|
|
|
|
#### _ReplaceMemberRolesRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| role_ids | [ string ], <br>**Default:** | | No |
|
|
|
|
#### _RequiredSecret
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| _RequiredSecret | string | | |
|
|
|
|
#### _ResourceAccessScopeRequest
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| automatic_include_workspace_members | boolean | | Yes |
|
|
|
|
#### _ResourceUserAccessPoliciesQuery
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| language | string, <br>**Available values:** "en", "ja", "zh" | Localized policy label language | No |
|
|
| limit | integer | | No |
|
|
| page | integer | | No |
|
|
| reverse | boolean | | No |
|
|
|
|
#### _RoleUpsertRequest
|
|
|
|
Accepts the payload sent by the Create/Edit Role dialog.
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| description | string | | No |
|
|
| name | string | | Yes |
|
|
| permission_keys | [ string ], <br>**Default:** | | No |
|
|
|
|
#### _SenderName
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| _SenderName | string | | |
|
|
|
|
#### _UUIDString
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| _UUIDString | string | | |
|
|
|
|
## FastOpenAPI Preview (OpenAPI 3.1)
|
|
|
|
### Dify API (FastOpenAPI PoC)
|
|
FastOpenAPI proof of concept for Dify API
|
|
|
|
#### Version: 1.0
|
|
|
|
---
|
|
|
|
##### [GET] /console/api/init
|
|
**Get initialization validation status.**
|
|
|
|
###### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | OK | **application/json**: [InitStatusResponse](#initstatusresponse)<br> |
|
|
|
|
##### [POST] /console/api/init
|
|
**Validate initialization password.**
|
|
|
|
###### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [InitValidatePayload](#initvalidatepayload)<br> |
|
|
|
|
###### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Created | **application/json**: [InitValidateResponse](#initvalidateresponse)<br> |
|
|
|
|
##### [GET] /console/api/ping
|
|
**Health check endpoint for connection testing.**
|
|
|
|
###### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | OK | **application/json**: [PingResponse](#pingresponse)<br> |
|
|
|
|
##### [GET] /console/api/setup
|
|
**Get system setup status.
|
|
|
|
NOTE: This endpoint is unauthenticated by design.
|
|
|
|
During first-time bootstrap there is no admin account yet, so frontend initialization must be
|
|
able to query setup progress before any login flow exists.
|
|
|
|
Only bootstrap-safe status information should be returned by this endpoint.
|
|
**
|
|
|
|
###### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | OK | **application/json**: [SetupStatusResponse](#setupstatusresponse)<br> |
|
|
|
|
##### [POST] /console/api/setup
|
|
**Initialize system setup with admin account.
|
|
|
|
NOTE: This endpoint is unauthenticated by design for first-time bootstrap.
|
|
Access is restricted to self-hosted editions (`COMMUNITY` and `ENTERPRISE`), one-time setup guards,
|
|
and init-password validation rather than user session authentication.
|
|
**
|
|
|
|
###### Request Body
|
|
|
|
| Required | Schema |
|
|
| -------- | ------ |
|
|
| Yes | **application/json**: [SetupRequestPayload](#setuprequestpayload)<br> |
|
|
|
|
###### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 201 | Created | **application/json**: [SetupResponse](#setupresponse)<br> |
|
|
|
|
##### [GET] /console/api/version
|
|
**Check for application version updates.**
|
|
|
|
###### Parameters
|
|
|
|
| Name | Located in | Description | Required | Schema |
|
|
| ---- | ---------- | ----------- | -------- | ------ |
|
|
| current_version | query | | Yes | string |
|
|
|
|
###### Responses
|
|
|
|
| Code | Description | Schema |
|
|
| ---- | ----------- | ------ |
|
|
| 200 | OK | **application/json**: [VersionResponse](#versionresponse)<br> |
|
|
|
|
---
|
|
##### Schemas
|
|
|
|
###### ErrorSchema
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| error | { **"details"**: string, **"message"**: string, **"status"**: integer, **"type"**: string } | | Yes |
|
|
|
|
###### InitStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| status | string, <br>**Available values:** "finished", "not_started" | Initialization status<br>*Enum:* `"finished"`, `"not_started"` | Yes |
|
|
|
|
###### InitValidatePayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| password | string | Initialization password | Yes |
|
|
|
|
###### InitValidateResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Operation result | Yes |
|
|
|
|
###### PingResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Health check result | Yes |
|
|
|
|
###### SetupRequestPayload
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| email | string | Admin email address | Yes |
|
|
| language | string | Admin language | No |
|
|
| name | string | Admin name (max 30 characters) | Yes |
|
|
| password | string | Admin password | Yes |
|
|
|
|
###### SetupResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| result | string | Setup result | Yes |
|
|
|
|
###### SetupStatusResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| setup_at | string | Setup completion time (ISO format) | No |
|
|
| step | string, <br>**Available values:** "finished", "not_started" | Setup step status<br>*Enum:* `"finished"`, `"not_started"` | Yes |
|
|
|
|
###### VersionResponse
|
|
|
|
| Name | Type | Description | Required |
|
|
| ---- | ---- | ----------- | -------- |
|
|
| release_notes | string | Release notes for latest version | Yes |
|
|
| version | string | Latest version number | Yes |
|