@leaflow/sdk 0.0.0-dev.359.gca6d1b5 → 0.0.0-dev.361.gefdc428
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assistant/v1/generated/functions.d.ts +1280 -560
- package/dist/assistant/v1/generated/functions.js +1288 -447
- package/dist/assistant/v1/generated/models.d.ts +1777 -979
- package/dist/assistant/v1/generated/models.js +196 -83
- package/dist/assistant/v1/generated/schemas.zod.d.ts +728 -313
- package/dist/assistant/v1/generated/schemas.zod.js +635 -274
- package/dist/assistant/v1/generated/validators/answerQuestionRequestBody.zod.d.ts +30 -0
- package/dist/assistant/v1/generated/validators/answerQuestionRequestBody.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/approvalMode.zod.d.ts +32 -0
- package/dist/assistant/v1/generated/validators/approvalMode.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/attachmentResource.zod.d.ts +19 -43
- package/dist/assistant/v1/generated/validators/attachmentResource.zod.js +23 -47
- package/dist/assistant/v1/generated/validators/bindingCodeResponseBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/bindingCodeResponseBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/bindingResource.zod.d.ts +16 -40
- package/dist/assistant/v1/generated/validators/bindingResource.zod.js +16 -40
- package/dist/assistant/v1/generated/validators/channelResource.zod.d.ts +18 -42
- package/dist/assistant/v1/generated/validators/channelResource.zod.js +17 -41
- package/dist/assistant/v1/generated/validators/channelWithSecretResponseBody.zod.d.ts +18 -42
- package/dist/assistant/v1/generated/validators/channelWithSecretResponseBody.zod.js +17 -41
- package/dist/assistant/v1/generated/validators/checkSenderParams.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/checkSenderParams.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/choiceResource.zod.d.ts +31 -0
- package/dist/assistant/v1/generated/validators/choiceResource.zod.js +29 -0
- package/dist/assistant/v1/generated/validators/clientActionRequest.zod.d.ts +21 -45
- package/dist/assistant/v1/generated/validators/clientActionRequest.zod.js +20 -47
- package/dist/assistant/v1/generated/validators/clientContextPart.zod.d.ts +16 -40
- package/dist/assistant/v1/generated/validators/clientContextPart.zod.js +17 -41
- package/dist/assistant/v1/generated/validators/clientContextRequest.zod.d.ts +23 -47
- package/dist/assistant/v1/generated/validators/clientContextRequest.zod.js +24 -48
- package/dist/assistant/v1/generated/validators/clientFunctionRequest.zod.d.ts +18 -42
- package/dist/assistant/v1/generated/validators/clientFunctionRequest.zod.js +24 -50
- package/dist/assistant/v1/generated/validators/commandListResponseBody.zod.d.ts +35 -0
- package/dist/assistant/v1/generated/validators/commandListResponseBody.zod.js +29 -0
- package/dist/assistant/v1/generated/validators/commandResource.zod.d.ts +33 -0
- package/dist/assistant/v1/generated/validators/commandResource.zod.js +33 -0
- package/dist/assistant/v1/generated/validators/commandResultResource.zod.d.ts +201 -0
- package/dist/assistant/v1/generated/validators/commandResultResource.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/completeUploadRequestBody.zod.d.ts +30 -0
- package/dist/assistant/v1/generated/validators/completeUploadRequestBody.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/contextUsageResource.zod.d.ts +31 -0
- package/dist/assistant/v1/generated/validators/contextUsageResource.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/createChannelRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/createChannelRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/createFolderRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/createFolderRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/createTaskRequestBody.zod.d.ts +61 -0
- package/dist/assistant/v1/generated/validators/createTaskRequestBody.zod.js +35 -0
- package/dist/assistant/v1/generated/validators/createThreadRequestBody.zod.d.ts +51 -41
- package/dist/assistant/v1/generated/validators/createThreadRequestBody.zod.js +33 -47
- package/dist/assistant/v1/generated/validators/createThreadResponseBody.zod.d.ts +118 -0
- package/dist/assistant/v1/generated/validators/createThreadResponseBody.zod.js +33 -0
- package/dist/assistant/v1/generated/validators/createUploadRequestBody.zod.d.ts +37 -0
- package/dist/assistant/v1/generated/validators/createUploadRequestBody.zod.js +35 -0
- package/dist/assistant/v1/generated/validators/credentialFieldResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/credentialFieldResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/cursorPagination.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/cursorPagination.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/decideToolCallsRequestBody.zod.d.ts +33 -0
- package/dist/assistant/v1/generated/validators/decideToolCallsRequestBody.zod.js +38 -0
- package/dist/assistant/v1/generated/validators/defaultModelResource.zod.d.ts +39 -0
- package/dist/assistant/v1/generated/validators/defaultModelResource.zod.js +38 -0
- package/dist/assistant/v1/generated/validators/error.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/error.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/fileDiffResource.zod.d.ts +18 -42
- package/dist/assistant/v1/generated/validators/fileDiffResource.zod.js +22 -46
- package/dist/assistant/v1/generated/validators/folderCountsResource.zod.d.ts +35 -0
- package/dist/assistant/v1/generated/validators/folderCountsResource.zod.js +35 -0
- package/dist/assistant/v1/generated/validators/folderListResponseBody.zod.d.ts +28 -43
- package/dist/assistant/v1/generated/validators/folderListResponseBody.zod.js +16 -40
- package/dist/assistant/v1/generated/validators/folderResource.zod.d.ts +27 -41
- package/dist/assistant/v1/generated/validators/folderResource.zod.js +23 -43
- package/dist/assistant/v1/generated/validators/itemFrame.zod.d.ts +36 -0
- package/dist/assistant/v1/generated/validators/itemFrame.zod.js +32 -0
- package/dist/assistant/v1/generated/validators/itemSourceResource.zod.d.ts +36 -0
- package/dist/assistant/v1/generated/validators/itemSourceResource.zod.js +31 -0
- package/dist/assistant/v1/generated/validators/lastTurnResource.zod.d.ts +43 -0
- package/dist/assistant/v1/generated/validators/lastTurnResource.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/lengthAwarePageBindingResource.zod.d.ts +16 -40
- package/dist/assistant/v1/generated/validators/lengthAwarePageBindingResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/lengthAwarePageChannelResource.zod.d.ts +18 -42
- package/dist/assistant/v1/generated/validators/lengthAwarePageChannelResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/listBindingsParams.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/listBindingsParams.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/listChannelRejectionsParams.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/listChannelRejectionsParams.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/listChannelsParams.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/listChannelsParams.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/listTaskRunsParams.zod.d.ts +34 -0
- package/dist/assistant/v1/generated/validators/listTaskRunsParams.zod.js +32 -0
- package/dist/assistant/v1/generated/validators/listThreadItemsParams.zod.d.ts +38 -0
- package/dist/assistant/v1/generated/validators/listThreadItemsParams.zod.js +40 -0
- package/dist/assistant/v1/generated/validators/listThreadTurnsParams.zod.d.ts +36 -0
- package/dist/assistant/v1/generated/validators/listThreadTurnsParams.zod.js +38 -0
- package/dist/assistant/v1/generated/validators/loginResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/loginResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/memoryListResponseBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/memoryListResponseBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/memoryResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/memoryResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/messagePart.zod.d.ts +17 -41
- package/dist/assistant/v1/generated/validators/messagePart.zod.js +20 -47
- package/dist/assistant/v1/generated/validators/moveFolderRequestBody.zod.d.ts +32 -0
- package/dist/assistant/v1/generated/validators/moveFolderRequestBody.zod.js +30 -0
- package/dist/assistant/v1/generated/validators/offsetPagination.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/offsetPagination.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/openRealtimeParams.zod.d.ts +31 -0
- package/dist/assistant/v1/generated/validators/openRealtimeParams.zod.js +29 -0
- package/dist/assistant/v1/generated/validators/partResource.zod.d.ts +17 -41
- package/dist/assistant/v1/generated/validators/partResource.zod.js +21 -45
- package/dist/assistant/v1/generated/validators/pendingActionResource.zod.d.ts +35 -0
- package/dist/assistant/v1/generated/validators/pendingActionResource.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/placeThreadRequestBody.zod.d.ts +33 -0
- package/dist/assistant/v1/generated/validators/placeThreadRequestBody.zod.js +34 -0
- package/dist/assistant/v1/generated/validators/platformListResponseBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/platformListResponseBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/platformResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/platformResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/presentationResource.zod.d.ts +23 -47
- package/dist/assistant/v1/generated/validators/presentationResource.zod.js +20 -42
- package/dist/assistant/v1/generated/validators/putUploadPartHeaders.zod.d.ts +30 -0
- package/dist/assistant/v1/generated/validators/putUploadPartHeaders.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/putUploadPartParams.zod.d.ts +30 -0
- package/dist/assistant/v1/generated/validators/putUploadPartParams.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/questionResource.zod.d.ts +36 -0
- package/dist/assistant/v1/generated/validators/questionResource.zod.js +34 -0
- package/dist/assistant/v1/generated/validators/realtimeClientMessage.zod.d.ts +38 -0
- package/dist/assistant/v1/generated/validators/realtimeClientMessage.zod.js +42 -0
- package/dist/assistant/v1/generated/validators/realtimeExchange.zod.d.ts +278 -0
- package/dist/assistant/v1/generated/validators/realtimeExchange.zod.js +33 -0
- package/dist/assistant/v1/generated/validators/realtimeServerMessage.zod.d.ts +267 -0
- package/dist/assistant/v1/generated/validators/realtimeServerMessage.zod.js +64 -0
- package/dist/assistant/v1/generated/validators/realtimeTicketResource.zod.d.ts +32 -0
- package/dist/assistant/v1/generated/validators/realtimeTicketResource.zod.js +30 -0
- package/dist/assistant/v1/generated/validators/reasoningEffort.zod.d.ts +32 -0
- package/dist/assistant/v1/generated/validators/reasoningEffort.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/rejectionListResponseBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/rejectionListResponseBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/rejectionResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/rejectionResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/resumeThreadRequestBody.zod.d.ts +31 -0
- package/dist/assistant/v1/generated/validators/resumeThreadRequestBody.zod.js +33 -0
- package/dist/assistant/v1/generated/validators/revertRequestBody.zod.d.ts +16 -39
- package/dist/assistant/v1/generated/validators/revertRequestBody.zod.js +18 -40
- package/dist/assistant/v1/generated/validators/revertedCountResponseBody.zod.d.ts +16 -39
- package/dist/assistant/v1/generated/validators/revertedCountResponseBody.zod.js +17 -40
- package/dist/assistant/v1/generated/validators/rotateSecretRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/rotateSecretRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/runCommandRequestBody.zod.d.ts +33 -0
- package/dist/assistant/v1/generated/validators/runCommandRequestBody.zod.js +39 -0
- package/dist/assistant/v1/generated/validators/searchTasksRequestBody.zod.d.ts +52 -0
- package/dist/assistant/v1/generated/validators/searchTasksRequestBody.zod.js +45 -0
- package/dist/assistant/v1/generated/validators/searchThreadsRequestBody.zod.d.ts +62 -0
- package/dist/assistant/v1/generated/validators/searchThreadsRequestBody.zod.js +83 -0
- package/dist/assistant/v1/generated/validators/sendMessageRequestBody.zod.d.ts +28 -52
- package/dist/assistant/v1/generated/validators/sendMessageRequestBody.zod.js +17 -41
- package/dist/assistant/v1/generated/validators/sendMessageResponseBody.zod.d.ts +33 -0
- package/dist/assistant/v1/generated/validators/sendMessageResponseBody.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/senderCheckResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/senderCheckResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/settingsResource.zod.d.ts +47 -0
- package/dist/assistant/v1/generated/validators/settingsResource.zod.js +34 -0
- package/dist/assistant/v1/generated/validators/skillEnabledRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/skillEnabledRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/skillListResponseBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/skillListResponseBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/skillRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/skillRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/skillResource.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/skillResource.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/statusReportResource.zod.d.ts +108 -0
- package/dist/assistant/v1/generated/validators/statusReportResource.zod.js +48 -0
- package/dist/assistant/v1/generated/validators/subagentCountResource.zod.d.ts +33 -0
- package/dist/assistant/v1/generated/validators/subagentCountResource.zod.js +31 -0
- package/dist/assistant/v1/generated/validators/taskAction.zod.d.ts +41 -0
- package/dist/assistant/v1/generated/validators/taskAction.zod.js +51 -0
- package/dist/assistant/v1/generated/validators/taskListResponseBody.zod.d.ts +89 -0
- package/dist/assistant/v1/generated/validators/taskListResponseBody.zod.js +30 -0
- package/dist/assistant/v1/generated/validators/taskResource.zod.d.ts +86 -0
- package/dist/assistant/v1/generated/validators/taskResource.zod.js +45 -0
- package/dist/assistant/v1/generated/validators/taskRunListResponseBody.zod.d.ts +47 -0
- package/dist/assistant/v1/generated/validators/taskRunListResponseBody.zod.js +30 -0
- package/dist/assistant/v1/generated/validators/taskRunResource.zod.d.ts +44 -0
- package/dist/assistant/v1/generated/validators/taskRunResource.zod.js +38 -0
- package/dist/assistant/v1/generated/validators/taskTrigger.zod.d.ts +51 -0
- package/dist/assistant/v1/generated/validators/taskTrigger.zod.js +64 -0
- package/dist/assistant/v1/generated/validators/threadCountsResource.zod.d.ts +37 -0
- package/dist/assistant/v1/generated/validators/threadCountsResource.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/threadItemListResponseBody.zod.d.ts +234 -0
- package/dist/assistant/v1/generated/validators/threadItemListResponseBody.zod.js +46 -0
- package/dist/assistant/v1/generated/validators/threadItemResource.zod.d.ts +127 -0
- package/dist/assistant/v1/generated/validators/threadItemResource.zod.js +84 -0
- package/dist/assistant/v1/generated/validators/threadListResponseBody.zod.d.ts +102 -48
- package/dist/assistant/v1/generated/validators/threadListResponseBody.zod.js +22 -45
- package/dist/assistant/v1/generated/validators/threadResource.zod.d.ts +116 -0
- package/dist/assistant/v1/generated/validators/threadResource.zod.js +94 -0
- package/dist/assistant/v1/generated/validators/threadStatus.zod.d.ts +35 -0
- package/dist/assistant/v1/generated/validators/threadStatus.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/threadTurnListResponseBody.zod.d.ts +74 -0
- package/dist/assistant/v1/generated/validators/threadTurnListResponseBody.zod.js +30 -0
- package/dist/assistant/v1/generated/validators/threadTurnResource.zod.d.ts +72 -0
- package/dist/assistant/v1/generated/validators/threadTurnResource.zod.js +69 -0
- package/dist/assistant/v1/generated/validators/todoResource.zod.d.ts +17 -41
- package/dist/assistant/v1/generated/validators/todoResource.zod.js +18 -42
- package/dist/assistant/v1/generated/validators/toolCallResource.zod.d.ts +64 -0
- package/dist/assistant/v1/generated/validators/toolCallResource.zod.js +71 -0
- package/dist/assistant/v1/generated/validators/toolResultRequestBody.zod.d.ts +36 -0
- package/dist/assistant/v1/generated/validators/toolResultRequestBody.zod.js +48 -0
- package/dist/assistant/v1/generated/validators/turnStartedResponseBody.zod.d.ts +30 -0
- package/dist/assistant/v1/generated/validators/turnStartedResponseBody.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/turnStatus.zod.d.ts +34 -0
- package/dist/assistant/v1/generated/validators/turnStatus.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/turnType.zod.d.ts +31 -0
- package/dist/assistant/v1/generated/validators/turnType.zod.js +28 -0
- package/dist/assistant/v1/generated/validators/updateChannelRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/updateChannelRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/updateFolderRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/updateFolderRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/updateSettingsRequestBody.zod.d.ts +36 -0
- package/dist/assistant/v1/generated/validators/updateSettingsRequestBody.zod.js +31 -0
- package/dist/assistant/v1/generated/validators/updateTaskRequestBody.zod.d.ts +59 -0
- package/dist/assistant/v1/generated/validators/updateTaskRequestBody.zod.js +33 -0
- package/dist/assistant/v1/generated/validators/updateThreadRequestBody.zod.d.ts +23 -44
- package/dist/assistant/v1/generated/validators/updateThreadRequestBody.zod.js +22 -59
- package/dist/assistant/v1/generated/validators/updateUploadRequestBody.zod.d.ts +31 -0
- package/dist/assistant/v1/generated/validators/updateUploadRequestBody.zod.js +29 -0
- package/dist/assistant/v1/generated/validators/uploadAttachmentParams.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/uploadAttachmentParams.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/uploadConfigurationResource.zod.d.ts +35 -0
- package/dist/assistant/v1/generated/validators/uploadConfigurationResource.zod.js +33 -0
- package/dist/assistant/v1/generated/validators/uploadListResponseBody.zod.d.ts +44 -0
- package/dist/assistant/v1/generated/validators/uploadListResponseBody.zod.js +29 -0
- package/dist/assistant/v1/generated/validators/uploadPartResource.zod.d.ts +32 -0
- package/dist/assistant/v1/generated/validators/uploadPartResource.zod.js +30 -0
- package/dist/assistant/v1/generated/validators/uploadResource.zod.d.ts +42 -0
- package/dist/assistant/v1/generated/validators/uploadResource.zod.js +37 -0
- package/dist/assistant/v1/generated/validators/uploadedResource.zod.d.ts +16 -40
- package/dist/assistant/v1/generated/validators/uploadedResource.zod.js +18 -42
- package/dist/assistant/v1/generated/validators/usage.zod.d.ts +44 -0
- package/dist/assistant/v1/generated/validators/usage.zod.js +61 -0
- package/dist/assistant/v1/generated/validators/verifyCodeRequestBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/verifyCodeRequestBody.zod.js +15 -39
- package/dist/assistant/v1/generated/validators/webhookSecretResponseBody.zod.d.ts +15 -39
- package/dist/assistant/v1/generated/validators/webhookSecretResponseBody.zod.js +15 -39
- package/dist/billing/type/order/v1/generated/validators/allowance.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/allowanceList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/creditGrant.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/creditGrantList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/discount.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/discountList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/featureGrant.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/featureGrantList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/featureGrantStatus.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/order.zod.d.ts +2 -2
- package/dist/billing/type/order/v1/generated/validators/orderItem.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/orderItemList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/orderItemStatus.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/orderList.zod.d.ts +2 -2
- package/dist/billing/type/order/v1/generated/validators/orderStatus.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/paymentMethod.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/paymentMethodList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/paymentResult.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/refund.zod.d.ts +2 -2
- package/dist/billing/type/order/v1/generated/validators/refundList.zod.d.ts +2 -2
- package/dist/billing/type/order/v1/generated/validators/scheduledChange.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/subscription.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/subscriptionList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/topUp.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/topUpList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/transaction.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/transactionList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/withdrawal.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/withdrawalItem.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/withdrawalItemList.zod.d.ts +1 -1
- package/dist/billing/type/order/v1/generated/validators/withdrawalList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/schemas.zod.d.ts +5 -5
- package/dist/billing/v1/generated/validators/allowance.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/allowanceList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/creditGrant.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/creditGrantList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/discount.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/discountList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/featureGrant.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/featureGrantList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/featureGrantStatus.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/listAllowancesParams.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/listCancellationsParams.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/listCreditGrantsParams.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/listFeatureGrantsParams.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/listOrdersParams.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/order.zod.d.ts +2 -2
- package/dist/billing/v1/generated/validators/orderItem.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/orderItemStatus.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/orderList.zod.d.ts +2 -2
- package/dist/billing/v1/generated/validators/orderStatus.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/paymentMethod.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/paymentMethodList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/paymentResult.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/refund.zod.d.ts +2 -2
- package/dist/billing/v1/generated/validators/refundList.zod.d.ts +2 -2
- package/dist/billing/v1/generated/validators/scheduledChange.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/subscription.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/topUp.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/topUpList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/transaction.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/transactionList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/withdrawal.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/withdrawalItem.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/withdrawalItemList.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/withdrawalList.zod.d.ts +1 -1
- package/dist/canopy/v1/generated/functions.d.ts +81 -6
- package/dist/canopy/v1/generated/functions.js +110 -6
- package/dist/canopy/v1/generated/models.d.ts +34 -16
- package/dist/canopy/v1/generated/models.js +5 -5
- package/dist/canopy/v1/generated/schemas.zod.d.ts +39 -5
- package/dist/canopy/v1/generated/schemas.zod.js +38 -5
- package/dist/canopy/v1/generated/validators/aPIKeyResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/aPIKeyResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/aPIKeyUsageListResponseBody.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/aPIKeyUsageListResponseBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/aPIKeyUsageResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/aPIKeyUsageResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/accountBalance.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/accountBalance.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/accountIdentity.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/accountIdentity.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/activeResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/activeResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/activeResourceList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/activeResourceList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/allowance.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/allowance.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/allowanceList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/allowanceList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/applicability.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/applicability.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/applicablePlan.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/applicablePlan.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/appliedCredit.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/appliedCredit.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/autoRenewSet.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/autoRenewSet.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/billingAccount.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/billingAccount.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/billingAccountCreate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/billingAccountCreate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/billingAccountList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/billingAccountList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/billingAccountUpdate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/billingAccountUpdate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/billingScheme.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/billingScheme.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancelSubscriptionRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancelSubscriptionRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellation.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellation.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellationCreate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellationCreate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellationItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellationItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellationList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellationList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellationPolicy.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellationPolicy.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellationRefundPreview.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cancellationRefundPreviewItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/chatCompletion.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/chatCompletion.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/chatCompletionRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/chatCompletionRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/checkoutMode.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/checkoutMode.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/checkoutOptions.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/checkoutOptions.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/contact.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/contact.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/contactCreate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/contactCreate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/contactList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/contactList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/contactUpdate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/contactUpdate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/createAPIKeyRequestBody.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/createAPIKeyRequestBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/createServiceRequestBody.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/createServiceRequestBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/createServiceResponseBody.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/createServiceResponseBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditGrant.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/creditGrant.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditGrantList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/creditGrantList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditGroup.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/creditGroup.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditNote.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/creditNote.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditNoteItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/creditNoteItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditNoteItemList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/creditNoteItemList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/creditNoteList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/creditNoteList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/currency.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/currency.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/currencyList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/currencyList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cursorPageRequestResource.zod.d.ts +12 -10
- package/dist/canopy/v1/generated/validators/cursorPageRequestResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/cursorPagination.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/cursorPagination.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/discount.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/discount.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/discountList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/discountList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/embeddingRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/embeddingRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/embeddingResponse.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/embeddingResponse.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/endpointCapabilities.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/endpointCapabilities.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/entitlement.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/entitlement.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/entitlementList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/entitlementList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/error.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/error.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/errorA200529.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/errorA200529.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/featureGrant.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/featureGrant.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/featureGrantList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/featureGrantList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/featureGrantStatus.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/featureGrantStatus.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/funds.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/funds.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/getUsageSummaryParams.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/getUsageSummaryParams.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/getUsageTimelineParams.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/getUsageTimelineParams.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/inferenceError.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/inferenceError.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoice.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoice.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoiceItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoiceItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoiceItemList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoiceItemList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoiceItemProration.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoiceItemProration.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoiceList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoiceList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoiceStatus.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoiceStatus.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/invoiceSummary.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/invoiceSummary.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/issuedAPIKeyResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/issuedAPIKeyResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/lengthAwarePageAPIKeyResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/lengthAwarePageAPIKeyResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/listApiKeysParams.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/listApiKeysParams.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/listRequestsParams.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/listRequestsParams.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/listUsageByApiKeyParams.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/listUsageByApiKeyParams.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/listUsageByModelParams.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/listUsageByModelParams.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modality.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/modality.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/model.zod.d.ts +14 -4
- package/dist/canopy/v1/generated/validators/model.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelCapabilities.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/modelCapabilities.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelEndpoint.zod.d.ts +14 -4
- package/dist/canopy/v1/generated/validators/modelEndpoint.zod.js +14 -4
- package/dist/canopy/v1/generated/validators/modelList.zod.d.ts +14 -4
- package/dist/canopy/v1/generated/validators/modelList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelListResponseBody.zod.d.ts +14 -4
- package/dist/canopy/v1/generated/validators/modelListResponseBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelPricing.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/modelPricing.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelResource.zod.d.ts +14 -4
- package/dist/canopy/v1/generated/validators/modelResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelUsageListResponseBody.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/modelUsageListResponseBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/modelUsageResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/modelUsageResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/money.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/money.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/monthlyStatement.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/monthlyStatement.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/monthlyStatementList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/monthlyStatementList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/namedIdentity.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/namedIdentity.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/nativeRequest.zod.d.ts +44 -0
- package/dist/canopy/v1/generated/validators/nativeRequest.zod.js +44 -0
- package/dist/canopy/v1/generated/validators/nativeResponse.zod.d.ts +44 -0
- package/dist/canopy/v1/generated/validators/nativeResponse.zod.js +44 -0
- package/dist/canopy/v1/generated/validators/objectIdentity.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/objectIdentity.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/offsetPagination.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/offsetPagination.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/order.zod.d.ts +14 -6
- package/dist/canopy/v1/generated/validators/order.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderCancel.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/orderCancel.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderItem.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/orderItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderItemList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/orderItemList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderItemStatus.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/orderItemStatus.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderList.zod.d.ts +14 -6
- package/dist/canopy/v1/generated/validators/orderList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderRefundQuote.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/orderRefundQuote.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderRefundQuoteInput.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/orderRefundQuoteInput.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/orderStatus.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/orderStatus.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paidWith.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paidWith.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/payInvoiceRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/payInvoiceRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/payTogetherRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/payTogetherRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentAction.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentAction.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentCancellationReason.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentCancellationReason.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentMethod.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/paymentMethod.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentMethodList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/paymentMethodList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentMethodSetup.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentMethodSetup.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentMethodSetupResult.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentMethodSetupResult.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentOption.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentOption.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentOptionList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentOptionList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentOptionMethod.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentOptionMethod.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentPreview.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentPreview.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentPreviewInvoice.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentPreviewInvoice.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentResult.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/paymentResult.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/paymentStatus.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/paymentStatus.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/placedOrder.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/placedOrder.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/plan.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/plan.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/planFeature.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/planFeature.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/planList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/planList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/price.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/price.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/priceList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/priceList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/priceOption.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/priceOption.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/priceType.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/priceType.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/product.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/product.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/productID.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/productID.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/productList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/productList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/projectAssignment.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/projectAssignment.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/projectAssignmentList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/projectAssignmentList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/purchaseOperation.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/purchaseOperation.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quote.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quote.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quote5f60d00.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quote5f60d00.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteA200529.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteA200529.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteCancellation.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteCancellation.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteItemDc1fddb.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteItemDc1fddb.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteItemInput.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteItemInput.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteRenewal.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteRenewal.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteRenewalResult.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteRenewalResult.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quoteRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quoteRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/quotedDiscount.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/quotedDiscount.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/rate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/rate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/rateList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/rateList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/reasoningCapabilities.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/reasoningCapabilities.zod.js +13 -5
- package/dist/canopy/v1/generated/validators/reasoningDiagnostics.zod.d.ts +12 -10
- package/dist/canopy/v1/generated/validators/reasoningDiagnostics.zod.js +12 -6
- package/dist/canopy/v1/generated/validators/refund.zod.d.ts +14 -6
- package/dist/canopy/v1/generated/validators/refund.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/refundList.zod.d.ts +14 -6
- package/dist/canopy/v1/generated/validators/refundList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/refundPolicy.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/refundPolicy.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/refundReason.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/refundReason.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/renewRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/renewRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/renewalOrderRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/renewalPrice.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/renewalPrice.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/renewalPriceList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/renewalPriceList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/requestResource.zod.d.ts +12 -10
- package/dist/canopy/v1/generated/validators/requestResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/responseCreate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/responseCreate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/responseDeleted.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/responseDeleted.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/responseResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/responseResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/scheduledChange.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/scheduledChange.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/serviceResource.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/serviceResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/setProjectAssignmentRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/setProjectAssignmentRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/spendRow.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/spendRow.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/spendRowList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/spendRowList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statement.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statement.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statementAmounts.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statementAmounts.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statementItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statementItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statementList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statementList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statementStatus.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statementStatus.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statementSummary.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statementSummary.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/statementType.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/statementType.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/streamGenerateContentParams.zod.d.ts +48 -0
- package/dist/canopy/v1/generated/validators/streamGenerateContentParams.zod.js +44 -0
- package/dist/canopy/v1/generated/validators/subscription.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/subscription.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/subscriptionCancellation.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/subscriptionCancellation.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/subscriptionList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/subscriptionList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/subscriptionRestriction.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/subscriptionRestriction.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/taxItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/taxItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/tier.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/tier.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/tokenPrice.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/tokenPrice.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/topUp.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/topUp.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/topUpCreate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/topUpCreate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/topUpList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/topUpList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/totalsResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/totalsResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/transaction.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/transaction.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/transactionList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/transactionList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/transactionType.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/transactionType.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/updateAPIKeyRequestBody.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/updateAPIKeyRequestBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/usageBucketResource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/usageBucketResource.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/usageCharge.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/usageCharge.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/usageChargeList.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/usageChargeList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/usageTimelineResponseBody.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/usageTimelineResponseBody.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/usageType.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/usageType.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawal.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/withdrawal.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalAllocation.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalAllocation.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalCreate.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalCreate.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalItem.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/withdrawalItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalItemList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/withdrawalItemList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalList.zod.d.ts +13 -5
- package/dist/canopy/v1/generated/validators/withdrawalList.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalPreview.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalPreview.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalPreviewItem.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalPreviewItem.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalPreviewRequest.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalPreviewRequest.zod.js +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalSource.zod.d.ts +12 -4
- package/dist/canopy/v1/generated/validators/withdrawalSource.zod.js +12 -4
- package/dist/compute/v1/generated/validators/allocateFloatingIPResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/backupCapacityPack.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/backupCapacityPackListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/backupService.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createBackupCapacityPackResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createBackupServiceResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createDiskResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/createImageResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/diskListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/diskResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/floatingIPListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/floatingIPResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/imageListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/imageResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/instanceListResponseBody.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/instanceResource.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/launchInstanceResponseBody.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/peeringListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/peeringResource.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/rebuildInstanceResponseBody.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/resizeDiskResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/resizeInstanceResponseBody.zod.d.ts +3 -3
- package/dist/compute/v1/generated/validators/setFloatingIPBandwidthResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/setSnapshotQuotaResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/snapshotListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/snapshotQuota.zod.d.ts +1 -1
- package/dist/compute/v1/generated/validators/snapshotResource.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/allowance.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/allowanceList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/creditGrant.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/creditGrantList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/discount.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/discountList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/featureGrant.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/featureGrantList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/featureGrantStatus.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/order.zod.d.ts +2 -2
- package/dist/membership/v1/generated/validators/orderItem.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/orderItemList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/orderItemStatus.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/orderList.zod.d.ts +2 -2
- package/dist/membership/v1/generated/validators/orderStatus.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/paymentMethod.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/paymentMethodList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/paymentResult.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/refund.zod.d.ts +2 -2
- package/dist/membership/v1/generated/validators/refundList.zod.d.ts +2 -2
- package/dist/membership/v1/generated/validators/scheduledChange.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/subscription.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/subscriptionList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/topUp.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/topUpList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/transaction.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/transactionList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/withdrawal.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/withdrawalItem.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/withdrawalItemList.zod.d.ts +1 -1
- package/dist/membership/v1/generated/validators/withdrawalList.zod.d.ts +1 -1
- package/dist/notification/v1/generated/schemas.zod.d.ts +3 -3
- package/dist/notification/v1/generated/validators/channelListResponseBody.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/channelResource.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/channelScope.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/createChannelRequestBody.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/listUserChannelsParams.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/notificationChannel.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/notificationTypeDescriptor.zod.d.ts +2 -2
- package/dist/notification/v1/generated/validators/notificationTypeListResponseBody.zod.d.ts +2 -2
- package/dist/notification/v1/generated/validators/typePreferenceListResponseBody.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/typePreferenceResource.zod.d.ts +1 -1
- package/dist/notification/v1/generated/validators/updateTypePreferenceRequestBody.zod.d.ts +1 -1
- package/dist/routes.d.ts +350 -78
- package/dist/routes.js +384 -78
- package/dist/type/resource/v1/generated/validators/reclamationState.zod.d.ts +1 -1
- package/package.json +1 -1
- package/dist/assistant/v1/generated/validators/answerRequestBody.zod.d.ts +0 -54
- package/dist/assistant/v1/generated/validators/answerRequestBody.zod.js +0 -54
- package/dist/assistant/v1/generated/validators/choice.zod.d.ts +0 -55
- package/dist/assistant/v1/generated/validators/choice.zod.js +0 -53
- package/dist/assistant/v1/generated/validators/contextResource.zod.d.ts +0 -59
- package/dist/assistant/v1/generated/validators/contextResource.zod.js +0 -62
- package/dist/assistant/v1/generated/validators/decideRequestBody.zod.d.ts +0 -55
- package/dist/assistant/v1/generated/validators/decideRequestBody.zod.js +0 -53
- package/dist/assistant/v1/generated/validators/documentResource.zod.d.ts +0 -181
- package/dist/assistant/v1/generated/validators/documentResource.zod.js +0 -71
- package/dist/assistant/v1/generated/validators/dynamicCallResultRequestBody.zod.d.ts +0 -60
- package/dist/assistant/v1/generated/validators/dynamicCallResultRequestBody.zod.js +0 -72
- package/dist/assistant/v1/generated/validators/earlierResource.zod.d.ts +0 -55
- package/dist/assistant/v1/generated/validators/earlierResource.zod.js +0 -53
- package/dist/assistant/v1/generated/validators/earlierResponseBody.zod.d.ts +0 -130
- package/dist/assistant/v1/generated/validators/earlierResponseBody.zod.js +0 -55
- package/dist/assistant/v1/generated/validators/itemResource.zod.d.ts +0 -124
- package/dist/assistant/v1/generated/validators/itemResource.zod.js +0 -101
- package/dist/assistant/v1/generated/validators/listEarlierItemsParams.zod.d.ts +0 -55
- package/dist/assistant/v1/generated/validators/listEarlierItemsParams.zod.js +0 -56
- package/dist/assistant/v1/generated/validators/listThreadsParams.zod.d.ts +0 -63
- package/dist/assistant/v1/generated/validators/listThreadsParams.zod.js +0 -72
- package/dist/assistant/v1/generated/validators/modelListResponseBody.zod.d.ts +0 -69
- package/dist/assistant/v1/generated/validators/modelListResponseBody.zod.js +0 -65
- package/dist/assistant/v1/generated/validators/modelResource.zod.d.ts +0 -65
- package/dist/assistant/v1/generated/validators/modelResource.zod.js +0 -81
- package/dist/assistant/v1/generated/validators/question.zod.d.ts +0 -60
- package/dist/assistant/v1/generated/validators/question.zod.js +0 -56
- package/dist/assistant/v1/generated/validators/streamResource.zod.d.ts +0 -55
- package/dist/assistant/v1/generated/validators/streamResource.zod.js +0 -53
- package/dist/assistant/v1/generated/validators/threadSummaryResource.zod.d.ts +0 -68
- package/dist/assistant/v1/generated/validators/threadSummaryResource.zod.js +0 -73
- package/dist/assistant/v1/generated/validators/turnIDResponseBody.zod.d.ts +0 -56
- package/dist/assistant/v1/generated/validators/turnIDResponseBody.zod.js +0 -61
- package/dist/assistant/v1/generated/validators/turnResource.zod.d.ts +0 -58
- package/dist/assistant/v1/generated/validators/turnResource.zod.js +0 -52
- package/dist/assistant/v1/generated/validators/waitResource.zod.d.ts +0 -71
- package/dist/assistant/v1/generated/validators/waitResource.zod.js +0 -59
|
@@ -2,102 +2,26 @@
|
|
|
2
2
|
* Generated by orval 🍺
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
* Leaflow Assistant API
|
|
5
|
-
*
|
|
5
|
+
* Conversations with agents that operate the Leaflow platform, plus their folders, tasks, files and
|
|
6
|
+
* chat-app channels.
|
|
6
7
|
*
|
|
7
|
-
*
|
|
8
|
+
* A conversation is a thread. A person talks to the main thread; the agent in it can start subagents,
|
|
9
|
+
* which are threads too and run on their own: stopping the main thread does not stop them, and each
|
|
10
|
+
* subagent tells its parent when it ends. A thread runs in turns; each turn records the model and
|
|
11
|
+
* reasoning effort it used and its token usage.
|
|
8
12
|
*
|
|
9
|
-
*
|
|
13
|
+
* Models come from the Canopy catalogue. A new thread uses the model it names, the caller's default
|
|
14
|
+
* from /api/v1/settings, or the first catalogue model that can run an agent. Reasoning models take one
|
|
15
|
+
* of three efforts — low, medium or high — which are sent to the model unchanged.
|
|
10
16
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* 4. When the assistant needs the user, the document's `wait` says which kind: approving a batch of tool calls (`POST /api/v1/threads/{thread}/approvals/{batch}`), or answering a few questions (`POST /api/v1/threads/{thread}/questions/{item}`). It continues on its own once that is handled.
|
|
17
|
+
* Read a thread's state with get-thread and its transcript with list-thread-items. Follow both live
|
|
18
|
+
* over the WebSocket described under /api/v1/realtime/tickets. Slash commands such as /status and
|
|
19
|
+
* /compact are listed by list-commands and work the same in the console and in chat apps.
|
|
15
20
|
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* Canopy owns the model catalogue and capabilities. Model ids in this API, conversation preferences and historical entries are Canopy model ids, with no separate assistant model registration. GET /api/v1/models returns the allowed, usable choices and allowModelSelection. Hide the selector when selection is disabled; the service enforces the same rule.
|
|
21
|
-
*
|
|
22
|
-
* preferredModelId is the user's choice. Null follows the platform default, including later changes. Disabled selection preserves but ignores preferences for new turns. A model removed from the allowlist, retired in Canopy or otherwise unusable falls back to the default without clearing the preference.
|
|
23
|
-
*
|
|
24
|
-
* Users can switch an existing conversation through PATCH /api/v1/threads/{thread} with preferredModelId. This preserves the transcript, starts no turn and makes no inference request. Null returns to following the default. Changes apply from the next turn; a running or waiting turn and messages queued into it retain their captured choices and fallback policy.
|
|
25
|
-
*
|
|
26
|
-
* If the chosen model cannot serve a request, the service may safely fall back to the default without confirmation or an additional switching message. If the default also fails, the turn fails normally; no third model is selected for ordinary answers. Fallback preserves executed tool results and never splices answers from different models. Invalid input, cancellation and a declined tool call do not trigger model fallback. Each entry's model records its actual Canopy author, not the saved preference.
|
|
27
|
-
*
|
|
28
|
-
* Users cannot choose a compaction model. Normal compaction reuses the effective model and reasoning settings for context-cache reuse. Only if that model cannot handle the compaction request or produce a summary fitting the target window may the service automatically use another allowed Canopy model with suitable capabilities. This does not change the preference or ordinary answer model, and is permitted even when user model selection is disabled.
|
|
29
|
-
*
|
|
30
|
-
* After compaction, the full next request, including instructions, tools and retained messages, must fit the target's usable prompt budget with room left for an answer, respecting its output limit. If still too large, further compaction attempts are bounded; exhaustion fails with CANNOT_FOLD instead of sending an oversized request or silently discarding history or images. The same checks apply when switching models or falling back. Each compaction entry records its actual author.
|
|
31
|
-
*
|
|
32
|
-
* An empty allowlist or unavailable default does not prevent reading conversations or saving permitted preference changes. A failed Canopy catalogue read is not evidence that a model was removed: use a valid cached snapshot or return MODEL_CATALOG_UNAVAILABLE, without deleting references or inventing capabilities. Catalogue presence is configuration information, not a live provider health check.
|
|
33
|
-
*
|
|
34
|
-
* ## Live output
|
|
35
|
-
*
|
|
36
|
-
* ```
|
|
37
|
-
* GET /api/v1/turns/{turn}/stream?ticket=<ticket>&cursor=<cursor>
|
|
38
|
-
* ```
|
|
39
|
-
*
|
|
40
|
-
* This is a Server-Sent Events stream, which is why it is not in the operation list below and why generated clients have no method for it. Open it with `EventSource`, or any SSE client. It is how live output arrives; polling the document on a timer is not the intended way to follow a conversation.
|
|
41
|
-
*
|
|
42
|
-
* - `path` and `ticket` both come from the conversation document's `stream`. `path` is relative, resolved against the address the document was fetched from;
|
|
43
|
-
* - `cursor` is where to start, from the document's `cursor`. Omit it to start at the beginning of what is still available;
|
|
44
|
-
* - every event is one incremental edit to that same document, so the same rendering logic applies;
|
|
45
|
-
* - the connection has a lifetime and closes cleanly when it ends. With `EventSource` the browser reconnects with `Last-Event-ID` and resumes by itself, so nothing needs handling;
|
|
46
|
-
* - three terminal events: `done` this turn finished (carrying its final status), `paused` the assistant is waiting on the user (fetch the document again and read `wait`), `stalled` execution was interrupted and will not resume — do not reconnect.
|
|
47
|
-
* OpenAPI spec version: 1.0.0
|
|
48
|
-
*/
|
|
49
|
-
export type ModelResourceInputModalitiesItem = (typeof ModelResourceInputModalitiesItem)[keyof typeof ModelResourceInputModalitiesItem];
|
|
50
|
-
export declare const ModelResourceInputModalitiesItem: {
|
|
51
|
-
readonly text: "text";
|
|
52
|
-
readonly image: "image";
|
|
53
|
-
};
|
|
54
|
-
/**
|
|
55
|
-
* A read-only view of a Canopy model. No model definition is created or edited through Assistant.
|
|
21
|
+
* Upload large files with /api/v1/uploads: read /api/v1/upload-configuration first, send exact-sized
|
|
22
|
+
* parts, then complete the upload and send its attachment id in a message.
|
|
23
|
+
* OpenAPI spec version: 2.0.0
|
|
56
24
|
*/
|
|
57
|
-
export interface ModelResource {
|
|
58
|
-
/**
|
|
59
|
-
* Canopy model id, used unchanged in settings, conversation preferences and inference. There is no second assistant model id.
|
|
60
|
-
* @minLength 1
|
|
61
|
-
* @maxLength 128
|
|
62
|
-
*/
|
|
63
|
-
id: string;
|
|
64
|
-
/** The display_name maintained in Canopy */
|
|
65
|
-
displayName: string;
|
|
66
|
-
/**
|
|
67
|
-
* The context_length maintained in Canopy. The assistant reserves room for instructions, tools and an answer rather than using this entire window for history.
|
|
68
|
-
* @minimum 1
|
|
69
|
-
*/
|
|
70
|
-
contextWindow: number;
|
|
71
|
-
/**
|
|
72
|
-
* The max_output_tokens maintained in Canopy. Answer and summary budgets must respect this limit and the remaining context capacity.
|
|
73
|
-
* @minimum 1
|
|
74
|
-
*/
|
|
75
|
-
maxOutputTokens: number;
|
|
76
|
-
/** Canopy supports_tools. Must be true before the model can be allowed for Assistant. */
|
|
77
|
-
supportsTools: boolean;
|
|
78
|
-
/** Canopy supports_reasoning. False requires reasoning_effort to be omitted. */
|
|
79
|
-
supportsReasoning: boolean;
|
|
80
|
-
/** Levels reported by Canopy reasoning_tiers. An empty list requires reasoning_effort to be omitted. List order does not imply reasoning strength. */
|
|
81
|
-
reasoningTiers: string[];
|
|
82
|
-
/**
|
|
83
|
-
* Contains text, and also image when Canopy reports supports_vision. Other attachments remain accessible through file tools.
|
|
84
|
-
* @minItems 1
|
|
85
|
-
*/
|
|
86
|
-
inputModalities: ModelResourceInputModalitiesItem[];
|
|
87
|
-
}
|
|
88
|
-
export interface ModelListResponseBody {
|
|
89
|
-
/** Whether users can set a non-null model preference. When false, hide the selector and use the platform default for new turns. */
|
|
90
|
-
allowModelSelection: boolean;
|
|
91
|
-
/**
|
|
92
|
-
* The default Canopy model id, present in models when non-null. Null means no usable default is known from the current allowlist and capability snapshot; it does not report live provider health.
|
|
93
|
-
* @minLength 1
|
|
94
|
-
* @maxLength 128
|
|
95
|
-
* @nullable
|
|
96
|
-
*/
|
|
97
|
-
defaultModelId: string | null;
|
|
98
|
-
/** Allowed, usable Canopy choices, or only the default when selection is disabled. Empty is an empty array, never null. */
|
|
99
|
-
models: ModelResource[];
|
|
100
|
-
}
|
|
101
25
|
/**
|
|
102
26
|
* What a given `code` carries alongside the message. The keys depend on the code,
|
|
103
27
|
* and a client that does not recognise one ignores it.
|
|
@@ -116,633 +40,708 @@ export interface Error {
|
|
|
116
40
|
status: number;
|
|
117
41
|
}
|
|
118
42
|
/**
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
* - `image` — read directly, and only by models that accept image input
|
|
122
|
-
* - `text` — placed inline in the message when small enough, otherwise read on demand
|
|
123
|
-
* - `binary` — never read directly; the assistant downloads it onto a cloud instance to work with it
|
|
43
|
+
* Tokens reported by Canopy. Cache hit rate is cachedInputTokens / inputTokens.
|
|
124
44
|
*/
|
|
125
|
-
export
|
|
126
|
-
export declare const UploadedResourceKind: {
|
|
127
|
-
readonly image: "image";
|
|
128
|
-
readonly text: "text";
|
|
129
|
-
readonly binary: "binary";
|
|
130
|
-
};
|
|
131
|
-
export interface UploadedResource {
|
|
132
|
-
/** Size of what was stored. For an image that has been resized, this is the resized size, not what was uploaded. */
|
|
133
|
-
byteSize: number;
|
|
45
|
+
export interface Usage {
|
|
134
46
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* It is here so the editor can say so before it happens. An attachment chip that quietly stops working a week later reads as a bug, and the person who hits it has no way to tell that what they are seeing is a draft being collected.
|
|
47
|
+
* Prompt tokens, including cached ones.
|
|
48
|
+
* @minimum 0
|
|
138
49
|
*/
|
|
139
|
-
|
|
140
|
-
filename: string;
|
|
50
|
+
inputTokens: number;
|
|
141
51
|
/**
|
|
142
|
-
*
|
|
143
|
-
* @
|
|
52
|
+
* Prompt tokens read from the provider's cache.
|
|
53
|
+
* @minimum 0
|
|
144
54
|
*/
|
|
145
|
-
|
|
146
|
-
id: string;
|
|
55
|
+
cachedInputTokens: number;
|
|
147
56
|
/**
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* - `image` — read directly, and only by models that accept image input
|
|
151
|
-
* - `text` — placed inline in the message when small enough, otherwise read on demand
|
|
152
|
-
* - `binary` — never read directly; the assistant downloads it onto a cloud instance to work with it
|
|
57
|
+
* Prompt tokens written to the provider's cache. Zero for providers that do not report it.
|
|
58
|
+
* @minimum 0
|
|
153
59
|
*/
|
|
154
|
-
|
|
60
|
+
cacheWriteTokens: number;
|
|
155
61
|
/**
|
|
156
|
-
*
|
|
157
|
-
* @
|
|
62
|
+
* Output tokens, including reasoning.
|
|
63
|
+
* @minimum 0
|
|
158
64
|
*/
|
|
159
|
-
|
|
65
|
+
outputTokens: number;
|
|
66
|
+
/**
|
|
67
|
+
* Output tokens spent on reasoning.
|
|
68
|
+
* @minimum 0
|
|
69
|
+
*/
|
|
70
|
+
reasoningTokens: number;
|
|
71
|
+
/** @minimum 0 */
|
|
72
|
+
totalTokens: number;
|
|
73
|
+
/**
|
|
74
|
+
* Model requests made.
|
|
75
|
+
* @minimum 0
|
|
76
|
+
*/
|
|
77
|
+
requests: number;
|
|
78
|
+
/** False while a request has not reported its usage yet, so the numbers may still grow. */
|
|
79
|
+
complete: boolean;
|
|
160
80
|
}
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
readonly
|
|
81
|
+
/**
|
|
82
|
+
* How much the model reasons before answering. Sent to the model unchanged.
|
|
83
|
+
*/
|
|
84
|
+
export type ReasoningEffort = (typeof ReasoningEffort)[keyof typeof ReasoningEffort];
|
|
85
|
+
export declare const ReasoningEffort: {
|
|
86
|
+
readonly low: "low";
|
|
87
|
+
readonly medium: "medium";
|
|
88
|
+
readonly high: "high";
|
|
167
89
|
};
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
90
|
+
/**
|
|
91
|
+
* `manual` asks a person before tools that change something, `guardian` lets an automatic reviewer decide, `yolo` runs them without asking.
|
|
92
|
+
*/
|
|
93
|
+
export type ApprovalMode = (typeof ApprovalMode)[keyof typeof ApprovalMode];
|
|
94
|
+
export declare const ApprovalMode: {
|
|
95
|
+
readonly manual: "manual";
|
|
96
|
+
readonly guardian: "guardian";
|
|
97
|
+
readonly yolo: "yolo";
|
|
173
98
|
};
|
|
174
|
-
export interface BindingResource {
|
|
175
|
-
channelId: string;
|
|
176
|
-
connState: BindingResourceConnState;
|
|
177
|
-
createdAt: string;
|
|
178
|
-
id: string;
|
|
179
|
-
peerName: string;
|
|
180
|
-
platform: string;
|
|
181
|
-
status: BindingResourceStatus;
|
|
182
|
-
/** @nullable */
|
|
183
|
-
verifiedAt: string | null;
|
|
184
|
-
}
|
|
185
|
-
export interface LengthAwarePageBindingResource {
|
|
186
|
-
/** The entries on this page */
|
|
187
|
-
items: BindingResource[];
|
|
188
|
-
/** The page size, echoing what was requested */
|
|
189
|
-
limit: number;
|
|
190
|
-
/** How many were skipped, echoing what was requested */
|
|
191
|
-
offset: number;
|
|
192
|
-
/** How many match in total, not just on this page */
|
|
193
|
-
total: number;
|
|
194
|
-
}
|
|
195
99
|
/**
|
|
196
|
-
*
|
|
100
|
+
* What the thread is doing. `waiting` is waiting for subagents or tasks it started; `awaiting_approval` and `awaiting_input` wait for a person.
|
|
197
101
|
*/
|
|
198
|
-
export type
|
|
199
|
-
export declare const
|
|
200
|
-
readonly
|
|
201
|
-
readonly
|
|
202
|
-
readonly
|
|
203
|
-
readonly
|
|
102
|
+
export type ThreadStatus = (typeof ThreadStatus)[keyof typeof ThreadStatus];
|
|
103
|
+
export declare const ThreadStatus: {
|
|
104
|
+
readonly idle: "idle";
|
|
105
|
+
readonly starting: "starting";
|
|
106
|
+
readonly running: "running";
|
|
107
|
+
readonly waiting: "waiting";
|
|
108
|
+
readonly awaiting_approval: "awaiting_approval";
|
|
109
|
+
readonly awaiting_input: "awaiting_input";
|
|
204
110
|
};
|
|
205
111
|
/**
|
|
206
|
-
*
|
|
112
|
+
* `declined` ended because a person declined a tool call; `cancelled` was stopped.
|
|
207
113
|
*/
|
|
208
|
-
export type
|
|
209
|
-
export declare const
|
|
210
|
-
readonly stopped: "stopped";
|
|
114
|
+
export type TurnStatus = (typeof TurnStatus)[keyof typeof TurnStatus];
|
|
115
|
+
export declare const TurnStatus: {
|
|
211
116
|
readonly running: "running";
|
|
117
|
+
readonly completed: "completed";
|
|
118
|
+
readonly failed: "failed";
|
|
119
|
+
readonly declined: "declined";
|
|
120
|
+
readonly cancelled: "cancelled";
|
|
212
121
|
};
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
122
|
+
/**
|
|
123
|
+
* `main` for a conversation with a person, `subagent` for one started by another agent.
|
|
124
|
+
*/
|
|
125
|
+
export type ThreadResourceRole = (typeof ThreadResourceRole)[keyof typeof ThreadResourceRole];
|
|
126
|
+
export declare const ThreadResourceRole: {
|
|
127
|
+
readonly main: "main";
|
|
128
|
+
readonly subagent: "subagent";
|
|
217
129
|
};
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
130
|
+
/**
|
|
131
|
+
* Where this step stands. At most one step is in_progress at any time.
|
|
132
|
+
*/
|
|
133
|
+
export type TodoResourceStatus = (typeof TodoResourceStatus)[keyof typeof TodoResourceStatus];
|
|
134
|
+
export declare const TodoResourceStatus: {
|
|
135
|
+
readonly pending: "pending";
|
|
136
|
+
readonly in_progress: "in_progress";
|
|
137
|
+
readonly completed: "completed";
|
|
223
138
|
};
|
|
224
|
-
export interface
|
|
225
|
-
/**
|
|
226
|
-
|
|
227
|
-
/**
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
139
|
+
export interface TodoResource {
|
|
140
|
+
/** The step as an instruction — "Install nginx". */
|
|
141
|
+
content: string;
|
|
142
|
+
/** The same step phrased as happening now — "Installing nginx". Show this one while the step is in progress. */
|
|
143
|
+
activeForm: string;
|
|
144
|
+
/** Where this step stands. At most one step is in_progress at any time. */
|
|
145
|
+
status: TodoResourceStatus;
|
|
146
|
+
}
|
|
147
|
+
export type PendingActionResourceType = (typeof PendingActionResourceType)[keyof typeof PendingActionResourceType];
|
|
148
|
+
export declare const PendingActionResourceType: {
|
|
149
|
+
readonly approval: "approval";
|
|
150
|
+
readonly question: "question";
|
|
151
|
+
};
|
|
152
|
+
/**
|
|
153
|
+
* A tool call that cannot continue until a person approves it or answers it.
|
|
154
|
+
*/
|
|
155
|
+
export interface PendingActionResource {
|
|
156
|
+
/** The conversation the tool call belongs to; a subagent's id when the subagent is the one waiting. */
|
|
157
|
+
threadId: string;
|
|
240
158
|
/**
|
|
241
|
-
* The
|
|
242
|
-
* @
|
|
159
|
+
* The waiting tool calls. Approvals come in batches; a question is a single item.
|
|
160
|
+
* @minItems 1
|
|
243
161
|
*/
|
|
244
|
-
|
|
162
|
+
itemIds: string[];
|
|
163
|
+
type: PendingActionResourceType;
|
|
245
164
|
}
|
|
246
|
-
export interface
|
|
247
|
-
/**
|
|
248
|
-
items: ChannelResource[];
|
|
249
|
-
/** The page size, echoing what was requested */
|
|
250
|
-
limit: number;
|
|
251
|
-
/** How many were skipped, echoing what was requested */
|
|
252
|
-
offset: number;
|
|
253
|
-
/** How many match in total, not just on this page */
|
|
165
|
+
export interface SubagentCountResource {
|
|
166
|
+
/** @minimum 0 */
|
|
254
167
|
total: number;
|
|
168
|
+
/** @minimum 0 */
|
|
169
|
+
running: number;
|
|
255
170
|
}
|
|
256
171
|
/**
|
|
257
|
-
*
|
|
172
|
+
* `message` answers messages; `compaction` summarizes the history to free the context window.
|
|
258
173
|
*/
|
|
259
|
-
export type
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
export declare const CreateChannelRequestBodySenderPolicy: {
|
|
264
|
-
readonly bound_only: "bound_only";
|
|
265
|
-
readonly open: "open";
|
|
174
|
+
export type TurnType = (typeof TurnType)[keyof typeof TurnType];
|
|
175
|
+
export declare const TurnType: {
|
|
176
|
+
readonly message: "message";
|
|
177
|
+
readonly compaction: "compaction";
|
|
266
178
|
};
|
|
267
|
-
export interface
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
credentials?: CreateChannelRequestBodyCredentials;
|
|
179
|
+
export interface LastTurnResource {
|
|
180
|
+
id: string;
|
|
181
|
+
type: TurnType;
|
|
182
|
+
status: TurnStatus;
|
|
272
183
|
/**
|
|
273
|
-
*
|
|
274
|
-
* @
|
|
184
|
+
* Why the turn failed. Null unless status is failed.
|
|
185
|
+
* @nullable
|
|
275
186
|
*/
|
|
276
|
-
|
|
277
|
-
/** @
|
|
278
|
-
|
|
279
|
-
senderPolicy?: CreateChannelRequestBodySenderPolicy;
|
|
280
|
-
/** Required for platforms that generate the secret themselves (secretSource=supplied). Must be absent for `generated` ones, where the secret we make is returned once in webhookSecret on this response */
|
|
281
|
-
webhookSecret?: string;
|
|
187
|
+
failureCode: string | null;
|
|
188
|
+
/** @nullable */
|
|
189
|
+
completedAt: string | null;
|
|
282
190
|
}
|
|
283
191
|
/**
|
|
284
|
-
* How
|
|
285
|
-
*/
|
|
286
|
-
export type ChannelWithSecretResponseBodyConnState = (typeof ChannelWithSecretResponseBodyConnState)[keyof typeof ChannelWithSecretResponseBodyConnState];
|
|
287
|
-
export declare const ChannelWithSecretResponseBodyConnState: {
|
|
288
|
-
readonly logged_out: "logged_out";
|
|
289
|
-
readonly qr_pending: "qr_pending";
|
|
290
|
-
readonly online: "online";
|
|
291
|
-
readonly expired: "expired";
|
|
292
|
-
};
|
|
293
|
-
/**
|
|
294
|
-
* The state of the long-lived connection right now. Always `stopped` for webhook platforms
|
|
192
|
+
* How much of the model's context window the conversation occupies.
|
|
295
193
|
*/
|
|
296
|
-
export
|
|
297
|
-
export declare const ChannelWithSecretResponseBodyRuntimeState: {
|
|
298
|
-
readonly stopped: "stopped";
|
|
299
|
-
readonly running: "running";
|
|
300
|
-
};
|
|
301
|
-
export type ChannelWithSecretResponseBodySenderPolicy = (typeof ChannelWithSecretResponseBodySenderPolicy)[keyof typeof ChannelWithSecretResponseBodySenderPolicy];
|
|
302
|
-
export declare const ChannelWithSecretResponseBodySenderPolicy: {
|
|
303
|
-
readonly bound_only: "bound_only";
|
|
304
|
-
readonly open: "open";
|
|
305
|
-
};
|
|
306
|
-
export type ChannelWithSecretResponseBodyStatus = (typeof ChannelWithSecretResponseBodyStatus)[keyof typeof ChannelWithSecretResponseBodyStatus];
|
|
307
|
-
export declare const ChannelWithSecretResponseBodyStatus: {
|
|
308
|
-
readonly active: "active";
|
|
309
|
-
readonly suspended: "suspended";
|
|
310
|
-
readonly disabled: "disabled";
|
|
311
|
-
};
|
|
312
|
-
export interface ChannelWithSecretResponseBody {
|
|
313
|
-
/** @nullable */
|
|
314
|
-
allowFrom: string[] | null;
|
|
315
|
-
/** How far this channel is from working. Only `online` receives messages and can issue binding codes */
|
|
316
|
-
connState: ChannelWithSecretResponseBodyConnState;
|
|
317
|
-
createdAt: string;
|
|
318
|
-
id: string;
|
|
319
|
-
name: string;
|
|
320
|
-
platform: string;
|
|
321
|
-
/** The state of the long-lived connection right now. Always `stopped` for webhook platforms */
|
|
322
|
-
runtimeState: ChannelWithSecretResponseBodyRuntimeState;
|
|
323
|
-
senderPolicy: ChannelWithSecretResponseBodySenderPolicy;
|
|
324
|
-
status: ChannelWithSecretResponseBodyStatus;
|
|
325
|
-
updatedAt: string;
|
|
326
|
-
/** The webhook path, for gateway configuration and for diagnosis */
|
|
327
|
-
webhookPath: string;
|
|
194
|
+
export interface ContextUsageResource {
|
|
328
195
|
/**
|
|
329
|
-
*
|
|
196
|
+
* Prompt tokens of the latest model request. Null before the first request.
|
|
330
197
|
* @nullable
|
|
331
198
|
*/
|
|
332
|
-
|
|
199
|
+
usedTokens: number | null;
|
|
333
200
|
/**
|
|
334
|
-
* The
|
|
201
|
+
* The context window of the conversation's model. Null when the model is not in the catalogue.
|
|
335
202
|
* @nullable
|
|
336
203
|
*/
|
|
337
|
-
|
|
204
|
+
windowTokens: number | null;
|
|
338
205
|
}
|
|
339
206
|
/**
|
|
340
|
-
*
|
|
341
|
-
|
|
342
|
-
export type UpdateChannelRequestBodyCredentials = {
|
|
343
|
-
[key: string]: string;
|
|
344
|
-
};
|
|
345
|
-
/**
|
|
346
|
-
* Only when this is sent is allowFrom replaced along with it
|
|
207
|
+
* A conversation with an agent. The main conversation and its subagents have the same shape;
|
|
208
|
+
* `role` tells them apart.
|
|
347
209
|
*/
|
|
348
|
-
export
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
};
|
|
353
|
-
export interface UpdateChannelRequestBody {
|
|
210
|
+
export interface ThreadResource {
|
|
211
|
+
id: string;
|
|
212
|
+
/** `main` for a conversation with a person, `subagent` for one started by another agent. */
|
|
213
|
+
role: ThreadResourceRole;
|
|
354
214
|
/**
|
|
355
|
-
* The
|
|
215
|
+
* The conversation that started this subagent. Null for main conversations.
|
|
356
216
|
* @nullable
|
|
357
217
|
*/
|
|
358
|
-
|
|
359
|
-
/** Replaced wholesale rather than merged key by key. Absent means unchanged */
|
|
360
|
-
credentials?: UpdateChannelRequestBodyCredentials;
|
|
361
|
-
enabled?: boolean;
|
|
362
|
-
/** @maxLength 128 */
|
|
363
|
-
name?: string;
|
|
364
|
-
/** Only when this is sent is allowFrom replaced along with it */
|
|
365
|
-
senderPolicy?: UpdateChannelRequestBodySenderPolicy;
|
|
366
|
-
}
|
|
367
|
-
export interface BindingCodeResponseBody {
|
|
368
|
-
code: string;
|
|
369
|
-
expiresAt: string;
|
|
370
|
-
}
|
|
371
|
-
export type PartResourceType = (typeof PartResourceType)[keyof typeof PartResourceType];
|
|
372
|
-
export declare const PartResourceType: {
|
|
373
|
-
readonly text: "text";
|
|
374
|
-
readonly file: "file";
|
|
375
|
-
};
|
|
376
|
-
export interface PartResource {
|
|
218
|
+
parentId: string | null;
|
|
377
219
|
/**
|
|
378
|
-
*
|
|
220
|
+
* The subagent's name, unique among the subagents of its parent. Null for main conversations.
|
|
379
221
|
* @nullable
|
|
380
222
|
*/
|
|
381
|
-
|
|
223
|
+
agentName: string | null;
|
|
382
224
|
/**
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
* Not an array index. It looks like one today because parts are only ever appended, and a
|
|
387
|
-
* client that treats it as one keeps working right up until that stops being true.
|
|
225
|
+
* Null until the conversation has a name.
|
|
226
|
+
* @nullable
|
|
388
227
|
*/
|
|
389
|
-
|
|
228
|
+
title: string | null;
|
|
390
229
|
/**
|
|
391
|
-
*
|
|
230
|
+
* The folder that holds this conversation. Null for subagents, which are not filed.
|
|
392
231
|
* @nullable
|
|
393
232
|
*/
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
/**
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
}
|
|
433
|
-
export type LoginResourceStatus = (typeof LoginResourceStatus)[keyof typeof LoginResourceStatus];
|
|
434
|
-
export declare const LoginResourceStatus: {
|
|
435
|
-
readonly wait: "wait";
|
|
436
|
-
readonly scanned: "scanned";
|
|
437
|
-
readonly confirmed: "confirmed";
|
|
438
|
-
readonly expired: "expired";
|
|
439
|
-
readonly error: "error";
|
|
440
|
-
readonly need_verify_code: "need_verify_code";
|
|
441
|
-
};
|
|
442
|
-
export interface LoginResource {
|
|
443
|
-
/** When this login flow expires. Past that, stop polling and start a new one */
|
|
444
|
-
expiresAt: string;
|
|
445
|
-
id: string;
|
|
446
|
-
/** The text to encode and render as a QR code by the client — not an image address and not a data URI. When a code expires this flow issues another and keeps waiting, so each poll may return a new string */
|
|
447
|
-
qrcodeData: string;
|
|
448
|
-
/** Why it failed. Present only when status is error or expired */
|
|
449
|
-
reason: string;
|
|
450
|
-
status: LoginResourceStatus;
|
|
451
|
-
}
|
|
452
|
-
export interface CredentialFieldResource {
|
|
453
|
-
help: string;
|
|
454
|
-
key: string;
|
|
455
|
-
label: string;
|
|
456
|
-
required: boolean;
|
|
457
|
-
secret: boolean;
|
|
233
|
+
folderId: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* The version of this conversation's place in its folder. Pass it as `expectedVersion` when moving it.
|
|
236
|
+
* @minimum 0
|
|
237
|
+
*/
|
|
238
|
+
orderVersion: number;
|
|
239
|
+
/** The Canopy model the next model request uses. */
|
|
240
|
+
modelId: string;
|
|
241
|
+
/** Null when the model does not reason. */
|
|
242
|
+
reasoningEffort: ReasoningEffort | null;
|
|
243
|
+
approvalMode: ApprovalMode;
|
|
244
|
+
status: ThreadStatus;
|
|
245
|
+
/**
|
|
246
|
+
* What the assistant is doing right now, for example "Reading nginx.conf". Null when idle.
|
|
247
|
+
* @nullable
|
|
248
|
+
*/
|
|
249
|
+
activity: string | null;
|
|
250
|
+
/**
|
|
251
|
+
* The beginning of the assistant's latest message.
|
|
252
|
+
* @nullable
|
|
253
|
+
*/
|
|
254
|
+
recentMessage: string | null;
|
|
255
|
+
/** The assistant's current plan, in order. Empty when it has none. */
|
|
256
|
+
todos: TodoResource[];
|
|
257
|
+
/** What this conversation is waiting for from a person. It may belong to one of its subagents. */
|
|
258
|
+
pendingAction: PendingActionResource | null;
|
|
259
|
+
subagents: SubagentCountResource;
|
|
260
|
+
/** The most recent turn. Null before the first message. */
|
|
261
|
+
lastTurn: LastTurnResource | null;
|
|
262
|
+
context: ContextUsageResource;
|
|
263
|
+
/** Token usage over the whole conversation. For a main conversation this includes its subagents. */
|
|
264
|
+
usage: Usage;
|
|
265
|
+
/** The assistant replied after the conversation was last marked read. */
|
|
266
|
+
unread: boolean;
|
|
267
|
+
archived: boolean;
|
|
268
|
+
createdAt: string;
|
|
269
|
+
/** The last activity. Renaming or moving the conversation does not change it. */
|
|
270
|
+
updatedAt: string;
|
|
458
271
|
}
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
};
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
272
|
+
/**
|
|
273
|
+
* @nullable
|
|
274
|
+
*/
|
|
275
|
+
export type MessagePartData = {
|
|
276
|
+
[key: string]: unknown;
|
|
277
|
+
} | null;
|
|
278
|
+
/**
|
|
279
|
+
* One piece of a message. `type` says which field carries it:
|
|
280
|
+
*
|
|
281
|
+
* - `text` — the words, in `text`
|
|
282
|
+
* - `file` — an attachment uploaded earlier, by id in `attachmentId`
|
|
283
|
+
* - `data-<name>` — context from the client, in `data`. The name is shown to the assistant so it
|
|
284
|
+
* can tell one block from another.
|
|
285
|
+
*/
|
|
286
|
+
export interface MessagePart {
|
|
287
|
+
/**
|
|
288
|
+
* @minLength 1
|
|
289
|
+
* @maxLength 64
|
|
290
|
+
*/
|
|
291
|
+
type: string;
|
|
477
292
|
/** @nullable */
|
|
478
|
-
|
|
479
|
-
name: string;
|
|
480
|
-
resident: boolean;
|
|
481
|
-
secretSource: PlatformResourceSecretSource;
|
|
482
|
-
setupChallenge: PlatformResourceSetupChallenge;
|
|
483
|
-
setupMethod: PlatformResourceSetupMethod;
|
|
484
|
-
/** The webhook path template; {channel} is replaced with the channel id */
|
|
485
|
-
webhookPath: string;
|
|
293
|
+
text?: string | null;
|
|
486
294
|
/**
|
|
487
|
-
* The
|
|
295
|
+
* The attachment must have been uploaded and not yet sent with another message.
|
|
488
296
|
* @nullable
|
|
489
297
|
*/
|
|
490
|
-
|
|
491
|
-
}
|
|
492
|
-
export interface PlatformListResponseBody {
|
|
298
|
+
attachmentId?: string | null;
|
|
493
299
|
/** @nullable */
|
|
494
|
-
|
|
495
|
-
}
|
|
496
|
-
export interface VerifyCodeRequestBody {
|
|
497
|
-
/** @minLength 1 */
|
|
498
|
-
code: string;
|
|
300
|
+
data?: MessagePartData;
|
|
499
301
|
}
|
|
302
|
+
export type ClientActionRequestType = (typeof ClientActionRequestType)[keyof typeof ClientActionRequestType];
|
|
303
|
+
export declare const ClientActionRequestType: {
|
|
304
|
+
readonly function: "function";
|
|
305
|
+
};
|
|
500
306
|
/**
|
|
501
|
-
*
|
|
307
|
+
* JSON Schema for the arguments. Omit for an action without arguments.
|
|
502
308
|
* @nullable
|
|
503
309
|
*/
|
|
504
|
-
export type
|
|
505
|
-
[key: string]:
|
|
310
|
+
export type ClientFunctionRequestParameters = {
|
|
311
|
+
[key: string]: unknown;
|
|
506
312
|
} | null;
|
|
507
313
|
/**
|
|
508
|
-
*
|
|
509
|
-
*
|
|
314
|
+
* The MCP and Anthropic name for `parameters`. Give one or the other.
|
|
315
|
+
* @nullable
|
|
510
316
|
*/
|
|
511
|
-
export type
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
};
|
|
516
|
-
export interface SkillResource {
|
|
317
|
+
export type ClientFunctionRequestInputSchema = {
|
|
318
|
+
[key: string]: unknown;
|
|
319
|
+
} | null;
|
|
320
|
+
export interface ClientFunctionRequest {
|
|
517
321
|
/**
|
|
518
|
-
*
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
* Which conversation is deliberately not returned: skills are shared across the project
|
|
522
|
-
* while conversations belong to one person, so naming one would tell everybody in the
|
|
523
|
-
* project that a particular colleague had it.
|
|
322
|
+
* @minLength 1
|
|
323
|
+
* @maxLength 64
|
|
524
324
|
*/
|
|
525
|
-
|
|
526
|
-
/** Why the assistant would open this skill. It sits in every request, so it is the one field worth writing carefully. */
|
|
527
|
-
description: string;
|
|
528
|
-
enabled: boolean;
|
|
325
|
+
name: string;
|
|
529
326
|
/**
|
|
530
|
-
*
|
|
531
|
-
* @
|
|
327
|
+
* What the action does, written for the model. OpenAI's limit on tool descriptions is 1024 characters.
|
|
328
|
+
* @minLength 1
|
|
329
|
+
* @maxLength 1024
|
|
532
330
|
*/
|
|
533
|
-
|
|
534
|
-
name: string;
|
|
331
|
+
description: string;
|
|
535
332
|
/**
|
|
536
|
-
*
|
|
537
|
-
*
|
|
333
|
+
* JSON Schema for the arguments. Omit for an action without arguments.
|
|
334
|
+
* @nullable
|
|
538
335
|
*/
|
|
539
|
-
|
|
540
|
-
/** @nullable */
|
|
541
|
-
shortDescription: string | null;
|
|
336
|
+
parameters?: ClientFunctionRequestParameters;
|
|
542
337
|
/**
|
|
543
|
-
*
|
|
338
|
+
* The MCP and Anthropic name for `parameters`. Give one or the other.
|
|
544
339
|
* @nullable
|
|
545
340
|
*/
|
|
546
|
-
|
|
341
|
+
inputSchema?: ClientFunctionRequestInputSchema;
|
|
547
342
|
}
|
|
548
|
-
|
|
549
|
-
|
|
343
|
+
/**
|
|
344
|
+
* A tool in the OpenAI Chat Completions format, plus `readOnly` and `timeoutMs`.
|
|
345
|
+
*/
|
|
346
|
+
export interface ClientActionRequest {
|
|
347
|
+
type?: ClientActionRequestType;
|
|
348
|
+
function: ClientFunctionRequest;
|
|
349
|
+
/** True when the action changes nothing outside the client. Other actions go through approval before they run. */
|
|
350
|
+
readOnly: boolean;
|
|
351
|
+
/**
|
|
352
|
+
* How long the assistant waits for this action. Longer values are capped.
|
|
353
|
+
* @minimum 0
|
|
354
|
+
*/
|
|
355
|
+
timeoutMs?: number;
|
|
550
356
|
}
|
|
551
357
|
/**
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
* 1 MiB in total.
|
|
358
|
+
* Which client this is and which actions it offers, so the assistant can ask it to run them while
|
|
359
|
+
* it answers. Send `actions` only when they changed since the last message; omitting them keeps
|
|
360
|
+
* what was declared before.
|
|
556
361
|
*/
|
|
557
|
-
export
|
|
558
|
-
[key: string]: string;
|
|
559
|
-
};
|
|
560
|
-
export interface SkillRequestBody {
|
|
362
|
+
export interface ClientContextRequest {
|
|
561
363
|
/**
|
|
562
|
-
*
|
|
364
|
+
* Identifies this client while it stays open; one per tab or process.
|
|
563
365
|
* @minLength 1
|
|
564
|
-
* @maxLength
|
|
366
|
+
* @maxLength 128
|
|
565
367
|
*/
|
|
566
|
-
|
|
567
|
-
enabled?: boolean;
|
|
368
|
+
clientId: string;
|
|
568
369
|
/**
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
* Paths are relative to the skill and cannot leave it. At most 32 files, 256 KiB each and
|
|
572
|
-
* 1 MiB in total.
|
|
370
|
+
* How the client names itself, for example "Leaflow console (web)".
|
|
371
|
+
* @maxLength 64
|
|
573
372
|
*/
|
|
574
|
-
|
|
373
|
+
label?: string;
|
|
575
374
|
/**
|
|
576
|
-
*
|
|
577
|
-
* @
|
|
578
|
-
* @
|
|
375
|
+
* The actions on offer now. `[]` withdraws all of them; null keeps the previous declaration.
|
|
376
|
+
* @maxItems 32
|
|
377
|
+
* @nullable
|
|
579
378
|
*/
|
|
580
|
-
|
|
581
|
-
/** @maxLength 1024 */
|
|
582
|
-
shortDescription?: string;
|
|
379
|
+
actions?: ClientActionRequest[] | null;
|
|
583
380
|
}
|
|
584
|
-
export interface
|
|
585
|
-
|
|
381
|
+
export interface SendMessageRequestBody {
|
|
382
|
+
/**
|
|
383
|
+
* The message, in the order it was written. A message with nothing but text is a single text
|
|
384
|
+
* part.
|
|
385
|
+
* @minItems 1
|
|
386
|
+
*/
|
|
387
|
+
parts: MessagePart[];
|
|
388
|
+
client?: ClientContextRequest;
|
|
586
389
|
}
|
|
587
|
-
export
|
|
588
|
-
export declare const ThreadSummaryResourceApprovalMode: {
|
|
589
|
-
readonly guardian: "guardian";
|
|
590
|
-
readonly manual: "manual";
|
|
591
|
-
readonly yolo: "yolo";
|
|
592
|
-
};
|
|
593
|
-
export interface ThreadSummaryResource {
|
|
594
|
-
approvalMode: ThreadSummaryResourceApprovalMode;
|
|
595
|
-
archived: boolean;
|
|
596
|
-
createdAt: string;
|
|
390
|
+
export interface CreateThreadRequestBody {
|
|
597
391
|
/**
|
|
598
|
-
*
|
|
599
|
-
* @
|
|
392
|
+
* @minLength 1
|
|
393
|
+
* @maxLength 255
|
|
600
394
|
*/
|
|
601
|
-
|
|
602
|
-
id: string;
|
|
395
|
+
title?: string;
|
|
603
396
|
/**
|
|
604
|
-
* The
|
|
605
|
-
* @
|
|
397
|
+
* The folder to file it in. Omit for the inbox.
|
|
398
|
+
* @maxLength 64
|
|
606
399
|
*/
|
|
607
|
-
|
|
400
|
+
folderId?: string;
|
|
608
401
|
/**
|
|
609
|
-
*
|
|
402
|
+
* Omit to use the caller's default model.
|
|
610
403
|
* @minLength 1
|
|
611
404
|
* @maxLength 128
|
|
612
|
-
* @nullable
|
|
613
405
|
*/
|
|
614
|
-
|
|
615
|
-
/**
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
406
|
+
modelId?: string;
|
|
407
|
+
/** Omit to use the caller's default effort, or medium. */
|
|
408
|
+
reasoningEffort?: ReasoningEffort;
|
|
409
|
+
approvalMode?: ApprovalMode;
|
|
410
|
+
message?: SendMessageRequestBody;
|
|
619
411
|
}
|
|
620
|
-
export interface
|
|
412
|
+
export interface CreateThreadResponseBody {
|
|
413
|
+
thread: ThreadResource;
|
|
621
414
|
/**
|
|
622
|
-
*
|
|
415
|
+
* The turn started by `message`. Null when no message was sent.
|
|
623
416
|
* @nullable
|
|
624
417
|
*/
|
|
625
|
-
|
|
626
|
-
/** @nullable */
|
|
627
|
-
threads: ThreadSummaryResource[] | null;
|
|
418
|
+
turnId: string | null;
|
|
628
419
|
}
|
|
629
420
|
/**
|
|
630
|
-
*
|
|
421
|
+
* Defaults to main unless parentId is given.
|
|
631
422
|
*/
|
|
632
|
-
export type
|
|
633
|
-
export declare const
|
|
634
|
-
readonly
|
|
423
|
+
export type SearchThreadsRequestBodyRole = (typeof SearchThreadsRequestBodyRole)[keyof typeof SearchThreadsRequestBodyRole];
|
|
424
|
+
export declare const SearchThreadsRequestBodyRole: {
|
|
425
|
+
readonly main: "main";
|
|
426
|
+
readonly subagent: "subagent";
|
|
427
|
+
};
|
|
428
|
+
/**
|
|
429
|
+
* `needs_action` is waiting for a person or ended with a failure, `running` is working,
|
|
430
|
+
* and `done` is everything else.
|
|
431
|
+
*/
|
|
432
|
+
export type SearchThreadsRequestBodyState = (typeof SearchThreadsRequestBodyState)[keyof typeof SearchThreadsRequestBodyState];
|
|
433
|
+
export declare const SearchThreadsRequestBodyState: {
|
|
434
|
+
readonly needs_action: "needs_action";
|
|
435
|
+
readonly running: "running";
|
|
436
|
+
readonly done: "done";
|
|
437
|
+
};
|
|
438
|
+
/**
|
|
439
|
+
* `attention` puts conversations that need action first, then running ones, then the most
|
|
440
|
+
* recent. `recent` orders by last activity. `manual` is the order inside a folder and requires
|
|
441
|
+
* folderId.
|
|
442
|
+
*/
|
|
443
|
+
export type SearchThreadsRequestBodySort = (typeof SearchThreadsRequestBodySort)[keyof typeof SearchThreadsRequestBodySort];
|
|
444
|
+
export declare const SearchThreadsRequestBodySort: {
|
|
445
|
+
readonly attention: "attention";
|
|
446
|
+
readonly recent: "recent";
|
|
635
447
|
readonly manual: "manual";
|
|
636
|
-
readonly yolo: "yolo";
|
|
637
448
|
};
|
|
638
|
-
export
|
|
639
|
-
|
|
640
|
-
|
|
449
|
+
export type SearchThreadsRequestBodyIncludeItem = (typeof SearchThreadsRequestBodyIncludeItem)[keyof typeof SearchThreadsRequestBodyIncludeItem];
|
|
450
|
+
export declare const SearchThreadsRequestBodyIncludeItem: {
|
|
451
|
+
readonly counts: "counts";
|
|
452
|
+
};
|
|
453
|
+
export interface SearchThreadsRequestBody {
|
|
454
|
+
/**
|
|
455
|
+
* Read these conversations, including subagents and archived ones. Cannot be combined with cursor.
|
|
456
|
+
* @minItems 1
|
|
457
|
+
* @maxItems 200
|
|
458
|
+
*/
|
|
459
|
+
ids?: string[];
|
|
460
|
+
/**
|
|
461
|
+
* Only conversations in this folder.
|
|
462
|
+
* @maxLength 64
|
|
463
|
+
*/
|
|
464
|
+
folderId?: string;
|
|
465
|
+
/**
|
|
466
|
+
* Only the subagents of this conversation.
|
|
467
|
+
* @maxLength 64
|
|
468
|
+
*/
|
|
469
|
+
parentId?: string;
|
|
470
|
+
/** Defaults to main unless parentId is given. */
|
|
471
|
+
role?: SearchThreadsRequestBodyRole;
|
|
472
|
+
/**
|
|
473
|
+
* `needs_action` is waiting for a person or ended with a failure, `running` is working,
|
|
474
|
+
* and `done` is everything else.
|
|
475
|
+
*/
|
|
476
|
+
state?: SearchThreadsRequestBodyState;
|
|
477
|
+
/** True for archived conversations only; otherwise unarchived only. */
|
|
478
|
+
archived?: boolean;
|
|
479
|
+
/**
|
|
480
|
+
* Matches titles, case-insensitively.
|
|
481
|
+
* @maxLength 100
|
|
482
|
+
*/
|
|
483
|
+
q?: string;
|
|
484
|
+
/**
|
|
485
|
+
* `attention` puts conversations that need action first, then running ones, then the most
|
|
486
|
+
* recent. `recent` orders by last activity. `manual` is the order inside a folder and requires
|
|
487
|
+
* folderId.
|
|
488
|
+
*/
|
|
489
|
+
sort?: SearchThreadsRequestBodySort;
|
|
490
|
+
/** @maxLength 1024 */
|
|
491
|
+
cursor?: string;
|
|
492
|
+
/**
|
|
493
|
+
* @minimum 1
|
|
494
|
+
* @maximum 200
|
|
495
|
+
*/
|
|
496
|
+
limit?: number;
|
|
497
|
+
/** Optional parts of the response. `counts` adds `counts`. */
|
|
498
|
+
include?: SearchThreadsRequestBodyIncludeItem[];
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* Counts over everything the criteria match, not only this page. `state`, `q` and the cursor are ignored.
|
|
502
|
+
*/
|
|
503
|
+
export interface ThreadCountsResource {
|
|
504
|
+
/** @minimum 0 */
|
|
505
|
+
total: number;
|
|
506
|
+
/** @minimum 0 */
|
|
507
|
+
needsAction: number;
|
|
508
|
+
/** @minimum 0 */
|
|
509
|
+
running: number;
|
|
510
|
+
/** @minimum 0 */
|
|
511
|
+
unread: number;
|
|
512
|
+
}
|
|
513
|
+
export interface ThreadListResponseBody {
|
|
514
|
+
threads: ThreadResource[];
|
|
515
|
+
/**
|
|
516
|
+
* Null on the last page.
|
|
517
|
+
* @nullable
|
|
518
|
+
*/
|
|
519
|
+
nextCursor: string | null;
|
|
520
|
+
/** Null unless `include` asked for it. */
|
|
521
|
+
counts: ThreadCountsResource | null;
|
|
522
|
+
}
|
|
523
|
+
export interface UpdateThreadRequestBody {
|
|
524
|
+
/**
|
|
525
|
+
* @minLength 1
|
|
526
|
+
* @maxLength 255
|
|
527
|
+
*/
|
|
528
|
+
title?: string;
|
|
641
529
|
/**
|
|
642
|
-
* A Canopy model id to prefer. Omit or pass null to follow the platform default. Non-null requires allowModelSelection; a disallowed, retired or removed id falls back to the default without clearing the preference.
|
|
643
530
|
* @minLength 1
|
|
644
531
|
* @maxLength 128
|
|
645
|
-
* @nullable
|
|
646
532
|
*/
|
|
647
|
-
|
|
533
|
+
modelId?: string;
|
|
534
|
+
reasoningEffort?: ReasoningEffort | null;
|
|
535
|
+
approvalMode?: ApprovalMode;
|
|
536
|
+
archived?: boolean;
|
|
648
537
|
}
|
|
649
|
-
export interface
|
|
650
|
-
/** @nullable */
|
|
651
|
-
compactAt: number | null;
|
|
538
|
+
export interface ResumeThreadRequestBody {
|
|
652
539
|
/**
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
* This governs images and nothing else. Text and binary attachments reach every model: a small text file is placed inline, a large one is read on demand, and a binary is downloaded onto a cloud instance — none of which asks the model to see a picture. So this decides whether pasting a screenshot does anything, not whether the attach control exists. Hiding file upload on a text-only model takes away something that would have worked.
|
|
656
|
-
*
|
|
657
|
-
* This describes the effective model, including a replacement chosen through fallback, rather than the saved preference. An empty list means no effective model is available to describe; it is not a claim that every model rejects files.
|
|
540
|
+
* Added to the conversation before the turn starts.
|
|
541
|
+
* @maxLength 20000
|
|
658
542
|
*/
|
|
659
|
-
|
|
543
|
+
message?: string;
|
|
544
|
+
}
|
|
545
|
+
export interface TurnStartedResponseBody {
|
|
546
|
+
turnId: string;
|
|
547
|
+
}
|
|
548
|
+
export interface RevertRequestBody {
|
|
660
549
|
/**
|
|
661
|
-
* The
|
|
662
|
-
* @
|
|
550
|
+
* The first item to revert; it and everything after it are reverted.
|
|
551
|
+
* @minimum 0
|
|
663
552
|
*/
|
|
664
|
-
|
|
665
|
-
/** @nullable */
|
|
666
|
-
used: number | null;
|
|
667
|
-
warnAt: number;
|
|
668
|
-
/** @nullable */
|
|
669
|
-
window: number | null;
|
|
553
|
+
ordinal: number;
|
|
670
554
|
}
|
|
671
|
-
export interface
|
|
672
|
-
|
|
673
|
-
|
|
555
|
+
export interface RevertedCountResponseBody {
|
|
556
|
+
/** @minimum 0 */
|
|
557
|
+
reverted: number;
|
|
674
558
|
}
|
|
675
559
|
/**
|
|
676
|
-
*
|
|
560
|
+
* Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
|
|
677
561
|
*/
|
|
678
|
-
export
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
562
|
+
export interface OffsetPagination {
|
|
563
|
+
/** @minimum 1 */
|
|
564
|
+
page: number;
|
|
565
|
+
/** @minimum 1 */
|
|
566
|
+
page_size: number;
|
|
567
|
+
/** @minimum 0 */
|
|
568
|
+
total_count?: number;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
|
|
572
|
+
*/
|
|
573
|
+
export interface CursorPagination {
|
|
574
|
+
/** @minimum 1 */
|
|
575
|
+
page_size: number;
|
|
576
|
+
/** @nullable */
|
|
577
|
+
next_cursor?: string | null;
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* One run of the agent, from the message that started it until it stopped.
|
|
581
|
+
*/
|
|
582
|
+
export interface ThreadTurnResource {
|
|
583
|
+
id: string;
|
|
584
|
+
threadId: string;
|
|
585
|
+
type: TurnType;
|
|
586
|
+
status: TurnStatus;
|
|
687
587
|
/**
|
|
688
|
-
*
|
|
588
|
+
* The first item the turn wrote. Null before it has written one.
|
|
689
589
|
* @nullable
|
|
690
590
|
*/
|
|
691
|
-
|
|
692
|
-
id: string;
|
|
693
|
-
/** What this attachment is. A client renders an image in place and everything else as a file to download. */
|
|
694
|
-
kind: AttachmentResourceKind;
|
|
591
|
+
firstOrdinal: number | null;
|
|
695
592
|
/**
|
|
696
|
-
*
|
|
593
|
+
* The last item the turn wrote so far.
|
|
697
594
|
* @nullable
|
|
698
595
|
*/
|
|
699
|
-
|
|
596
|
+
lastOrdinal: number | null;
|
|
597
|
+
/**
|
|
598
|
+
* The beginning of the message that started the turn. Null for compaction turns and turns started by the assistant itself.
|
|
599
|
+
* @nullable
|
|
600
|
+
*/
|
|
601
|
+
preview: string | null;
|
|
602
|
+
modelId: string;
|
|
603
|
+
reasoningEffort: ReasoningEffort | null;
|
|
604
|
+
approvalMode: ApprovalMode;
|
|
605
|
+
/**
|
|
606
|
+
* Why the turn failed. Null unless status is failed.
|
|
607
|
+
* @nullable
|
|
608
|
+
*/
|
|
609
|
+
failureCode: string | null;
|
|
610
|
+
/**
|
|
611
|
+
* How many tools the turn called.
|
|
612
|
+
* @minimum 0
|
|
613
|
+
*/
|
|
614
|
+
toolCalls: number;
|
|
615
|
+
/** Tokens used by every model request of this turn, including title generation, review and compaction. */
|
|
616
|
+
usage: Usage;
|
|
617
|
+
startedAt: string;
|
|
618
|
+
/**
|
|
619
|
+
* When the first output token arrived. Null until then.
|
|
620
|
+
* @nullable
|
|
621
|
+
*/
|
|
622
|
+
firstTokenAt: string | null;
|
|
623
|
+
/**
|
|
624
|
+
* Null while the turn is running.
|
|
625
|
+
* @nullable
|
|
626
|
+
*/
|
|
627
|
+
completedAt: string | null;
|
|
700
628
|
}
|
|
629
|
+
export interface ThreadTurnListResponseBody {
|
|
630
|
+
/** Newest first. */
|
|
631
|
+
turns: ThreadTurnResource[];
|
|
632
|
+
/** @nullable */
|
|
633
|
+
nextCursor: string | null;
|
|
634
|
+
}
|
|
635
|
+
export type ThreadItemResourceType = (typeof ThreadItemResourceType)[keyof typeof ThreadItemResourceType];
|
|
636
|
+
export declare const ThreadItemResourceType: {
|
|
637
|
+
readonly user_message: "user_message";
|
|
638
|
+
readonly external_message: "external_message";
|
|
639
|
+
readonly agent_message: "agent_message";
|
|
640
|
+
readonly reasoning: "reasoning";
|
|
641
|
+
readonly tool_call: "tool_call";
|
|
642
|
+
readonly compaction: "compaction";
|
|
643
|
+
readonly token_budget_reminder: "token_budget_reminder";
|
|
644
|
+
readonly turn_failure: "turn_failure";
|
|
645
|
+
};
|
|
701
646
|
/**
|
|
702
|
-
*
|
|
647
|
+
* `queued` is a message sent while the assistant was busy that it has not read yet.
|
|
703
648
|
*/
|
|
704
|
-
export type
|
|
705
|
-
export declare const
|
|
706
|
-
readonly
|
|
707
|
-
readonly declined: "declined";
|
|
708
|
-
readonly auto_approved: "auto_approved";
|
|
709
|
-
readonly unreviewed: "unreviewed";
|
|
710
|
-
};
|
|
711
|
-
export type ItemResourceStatus = (typeof ItemResourceStatus)[keyof typeof ItemResourceStatus];
|
|
712
|
-
export declare const ItemResourceStatus: {
|
|
649
|
+
export type ThreadItemResourceStatus = (typeof ThreadItemResourceStatus)[keyof typeof ThreadItemResourceStatus];
|
|
650
|
+
export declare const ThreadItemResourceStatus: {
|
|
651
|
+
readonly queued: "queued";
|
|
713
652
|
readonly pending: "pending";
|
|
714
653
|
readonly in_progress: "in_progress";
|
|
715
654
|
readonly completed: "completed";
|
|
716
655
|
readonly failed: "failed";
|
|
717
656
|
readonly declined: "declined";
|
|
718
|
-
readonly
|
|
657
|
+
readonly cancelled: "cancelled";
|
|
719
658
|
};
|
|
720
659
|
/**
|
|
721
|
-
*
|
|
660
|
+
* `subagent` for a subagent reporting to its parent, `thread` for another of the person's
|
|
661
|
+
* conversations, `task` for a task, `channel` for a chat app.
|
|
722
662
|
*/
|
|
723
|
-
export type
|
|
724
|
-
export declare const
|
|
725
|
-
readonly
|
|
726
|
-
readonly
|
|
727
|
-
readonly
|
|
728
|
-
readonly
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
663
|
+
export type ItemSourceResourceType = (typeof ItemSourceResourceType)[keyof typeof ItemSourceResourceType];
|
|
664
|
+
export declare const ItemSourceResourceType: {
|
|
665
|
+
readonly subagent: "subagent";
|
|
666
|
+
readonly thread: "thread";
|
|
667
|
+
readonly task: "task";
|
|
668
|
+
readonly channel: "channel";
|
|
669
|
+
};
|
|
670
|
+
export interface ItemSourceResource {
|
|
671
|
+
/**
|
|
672
|
+
* `subagent` for a subagent reporting to its parent, `thread` for another of the person's
|
|
673
|
+
* conversations, `task` for a task, `channel` for a chat app.
|
|
674
|
+
*/
|
|
675
|
+
type: ItemSourceResourceType;
|
|
676
|
+
/** The conversation, task or channel the message came from. */
|
|
677
|
+
id: string;
|
|
678
|
+
}
|
|
679
|
+
export type PartResourceType = (typeof PartResourceType)[keyof typeof PartResourceType];
|
|
680
|
+
export declare const PartResourceType: {
|
|
681
|
+
readonly text: "text";
|
|
682
|
+
readonly file: "file";
|
|
683
|
+
};
|
|
684
|
+
export interface PartResource {
|
|
685
|
+
/**
|
|
686
|
+
* Addresses this part in the realtime stream: text arrives as `append` frames pointing at
|
|
687
|
+
* `/items/{item}/parts/{id}/text`. Not an array index.
|
|
688
|
+
*/
|
|
689
|
+
id: string;
|
|
690
|
+
type: PartResourceType;
|
|
691
|
+
/**
|
|
692
|
+
* For `text` parts. Grows as the answer is written.
|
|
693
|
+
* @nullable
|
|
694
|
+
*/
|
|
695
|
+
text: string | null;
|
|
696
|
+
/**
|
|
697
|
+
* For `file` parts. Points at one of the item's `attachments`.
|
|
698
|
+
* @nullable
|
|
699
|
+
*/
|
|
700
|
+
attachmentId: string | null;
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* A client renders an image in place and everything else as a file to download.
|
|
704
|
+
*/
|
|
705
|
+
export type AttachmentResourceType = (typeof AttachmentResourceType)[keyof typeof AttachmentResourceType];
|
|
706
|
+
export declare const AttachmentResourceType: {
|
|
707
|
+
readonly image: "image";
|
|
708
|
+
readonly text: "text";
|
|
709
|
+
readonly binary: "binary";
|
|
732
710
|
};
|
|
711
|
+
export interface AttachmentResource {
|
|
712
|
+
id: string;
|
|
713
|
+
/** A client renders an image in place and everything else as a file to download. */
|
|
714
|
+
type: AttachmentResourceType;
|
|
715
|
+
filename: string;
|
|
716
|
+
byteSize: number;
|
|
717
|
+
/**
|
|
718
|
+
* Null unless type is image. Lets a client hold the space before the image loads.
|
|
719
|
+
* @nullable
|
|
720
|
+
*/
|
|
721
|
+
width: number | null;
|
|
722
|
+
/**
|
|
723
|
+
* Null unless type is image.
|
|
724
|
+
* @nullable
|
|
725
|
+
*/
|
|
726
|
+
height: number | null;
|
|
727
|
+
}
|
|
733
728
|
export type ClientContextPartData = {
|
|
734
729
|
[key: string]: unknown;
|
|
735
730
|
};
|
|
736
731
|
/**
|
|
737
|
-
* A `data-*` part as
|
|
732
|
+
* A `data-*` part as the client sent it.
|
|
738
733
|
*/
|
|
739
734
|
export interface ClientContextPart {
|
|
740
|
-
data: ClientContextPartData;
|
|
741
735
|
type: string;
|
|
736
|
+
data: ClientContextPartData;
|
|
742
737
|
}
|
|
743
738
|
/**
|
|
744
|
-
*
|
|
739
|
+
* Determines which of the remaining fields is populated.
|
|
745
740
|
*/
|
|
741
|
+
export type PresentationResourceType = (typeof PresentationResourceType)[keyof typeof PresentationResourceType];
|
|
742
|
+
export declare const PresentationResourceType: {
|
|
743
|
+
readonly file_diff: "file_diff";
|
|
744
|
+
};
|
|
746
745
|
export type FileDiffResourceStatus = (typeof FileDiffResourceStatus)[keyof typeof FileDiffResourceStatus];
|
|
747
746
|
export declare const FileDiffResourceStatus: {
|
|
748
747
|
readonly added: "added";
|
|
@@ -750,466 +749,1291 @@ export declare const FileDiffResourceStatus: {
|
|
|
750
749
|
readonly deleted: "deleted";
|
|
751
750
|
};
|
|
752
751
|
/**
|
|
753
|
-
* The change a tool call applied to a single file.
|
|
754
|
-
*
|
|
755
|
-
* Populated once the call has completed successfully. It is absent while the call is pending
|
|
756
|
-
* or awaiting approval, as the file's prior contents are read during execution. To preview an
|
|
757
|
-
* edit awaiting approval, derive it from the call's `old_string` and `new_string` arguments.
|
|
752
|
+
* The change a tool call applied to a single file. Present once the call has completed; while it
|
|
753
|
+
* awaits approval, derive a preview from its `old_string` and `new_string` arguments.
|
|
758
754
|
*/
|
|
759
755
|
export interface FileDiffResource {
|
|
760
|
-
/**
|
|
761
|
-
added: number;
|
|
762
|
-
/** Absolute path of the file on the instance */
|
|
756
|
+
/** Absolute path of the file on the instance. */
|
|
763
757
|
path: string;
|
|
764
|
-
/** Lines removed. Complete even when `unified` is null */
|
|
765
|
-
removed: number;
|
|
766
|
-
/** What the call did to the file */
|
|
767
758
|
status: FileDiffResourceStatus;
|
|
759
|
+
/** Lines added. Complete even when `unified` is null. */
|
|
760
|
+
added: number;
|
|
761
|
+
/** Lines removed. Complete even when `unified` is null. */
|
|
762
|
+
removed: number;
|
|
768
763
|
/**
|
|
769
|
-
* The change as a unified diff with three lines of context.
|
|
770
|
-
* diffed against `/dev/null`.
|
|
771
|
-
*
|
|
772
|
-
* Null when the change exceeds the service's size limit. The diff is omitted in full
|
|
773
|
-
* rather than truncated; `added` and `removed` remain complete.
|
|
764
|
+
* The change as a unified diff with three lines of context. Null when it exceeds the size limit.
|
|
774
765
|
* @nullable
|
|
775
766
|
*/
|
|
776
|
-
unified
|
|
767
|
+
unified: string | null;
|
|
777
768
|
}
|
|
778
769
|
/**
|
|
779
|
-
*
|
|
770
|
+
* Structured detail produced by a tool call, in addition to the one-line `detail`.
|
|
780
771
|
*/
|
|
781
|
-
export
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
772
|
+
export interface PresentationResource {
|
|
773
|
+
/** Determines which of the remaining fields is populated. */
|
|
774
|
+
type: PresentationResourceType;
|
|
775
|
+
fileDiff: FileDiffResource | null;
|
|
776
|
+
}
|
|
785
777
|
/**
|
|
786
|
-
*
|
|
787
|
-
*
|
|
788
|
-
*
|
|
789
|
-
* `kind` determines which of the remaining fields is populated.
|
|
778
|
+
* Whether the call needed a decision before it ran. Null for calls that need none.
|
|
779
|
+
* `auto_approved` was approved by the automatic reviewer.
|
|
780
|
+
* @nullable
|
|
790
781
|
*/
|
|
791
|
-
export
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
782
|
+
export type ToolCallResourceApprovalStatus = (typeof ToolCallResourceApprovalStatus)[keyof typeof ToolCallResourceApprovalStatus] | null;
|
|
783
|
+
export declare const ToolCallResourceApprovalStatus: {
|
|
784
|
+
readonly pending: "pending";
|
|
785
|
+
readonly reviewing: "reviewing";
|
|
786
|
+
readonly approved: "approved";
|
|
787
|
+
readonly auto_approved: "auto_approved";
|
|
788
|
+
readonly declined: "declined";
|
|
789
|
+
readonly unreviewed: "unreviewed";
|
|
790
|
+
};
|
|
791
|
+
export interface ChoiceResource {
|
|
792
|
+
label: string;
|
|
793
|
+
description: string;
|
|
795
794
|
}
|
|
796
|
-
export interface
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
795
|
+
export interface QuestionResource {
|
|
796
|
+
id: string;
|
|
797
|
+
/** A short label for the question. */
|
|
798
|
+
header: string;
|
|
799
|
+
question: string;
|
|
800
|
+
/** Suggested answers. A free-form answer is accepted as well. */
|
|
801
|
+
choices: ChoiceResource[];
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* The answers given so far, by question id. Null for other calls.
|
|
805
|
+
* @nullable
|
|
806
|
+
*/
|
|
807
|
+
export type ToolCallResourceAnswers = {
|
|
808
|
+
[key: string]: string;
|
|
809
|
+
} | null;
|
|
810
|
+
export interface ToolCallResource {
|
|
811
|
+
/** The tool's group, for example `instance`, `leaflow`, `agent` or `client`. Empty for tools without one. */
|
|
812
|
+
namespace: string;
|
|
813
|
+
tool: string;
|
|
814
|
+
/** The arguments as JSON text. Cut in lists when long; then it is no longer valid JSON. */
|
|
815
|
+
arguments: string;
|
|
816
|
+
/**
|
|
817
|
+
* What the call acts on, for display, such as a file path or an instance name.
|
|
818
|
+
* @nullable
|
|
819
|
+
*/
|
|
820
|
+
target: string | null;
|
|
804
821
|
/**
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
* **Not part of what the operator wrote** — `text` is. Render the message from `text` and
|
|
808
|
-
* leave these out of the bubble; they are here so a client that did not send them, or one
|
|
809
|
-
* that reloaded, can still read what the assistant was given.
|
|
810
|
-
*
|
|
811
|
-
* The actions declared alongside them are not returned: they are re-declared as they
|
|
812
|
-
* change and would make every fetch of the conversation carry them again.
|
|
822
|
+
* A one-line description of what the call did.
|
|
813
823
|
* @nullable
|
|
814
824
|
*/
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
/**
|
|
818
|
-
|
|
819
|
-
|
|
825
|
+
detail: string | null;
|
|
826
|
+
presentation: PresentationResource | null;
|
|
827
|
+
/**
|
|
828
|
+
* Whether the call needed a decision before it ran. Null for calls that need none.
|
|
829
|
+
* `auto_approved` was approved by the automatic reviewer.
|
|
830
|
+
* @nullable
|
|
831
|
+
*/
|
|
832
|
+
approvalStatus: ToolCallResourceApprovalStatus;
|
|
820
833
|
/** @nullable */
|
|
821
|
-
|
|
834
|
+
approvalReason: string | null;
|
|
835
|
+
/**
|
|
836
|
+
* When a person or the reviewer decided the call or answered its questions.
|
|
837
|
+
* @nullable
|
|
838
|
+
*/
|
|
839
|
+
decidedAt: string | null;
|
|
840
|
+
/**
|
|
841
|
+
* The questions of an `ask` call. Null for other calls.
|
|
842
|
+
* @nullable
|
|
843
|
+
*/
|
|
844
|
+
questions: QuestionResource[] | null;
|
|
845
|
+
/**
|
|
846
|
+
* The answers given so far, by question id. Null for other calls.
|
|
847
|
+
* @nullable
|
|
848
|
+
*/
|
|
849
|
+
answers: ToolCallResourceAnswers;
|
|
850
|
+
/**
|
|
851
|
+
* How long an `ask` call waits before it continues with its default answers. Null when it waits indefinitely.
|
|
852
|
+
* @nullable
|
|
853
|
+
*/
|
|
854
|
+
autoAnswerMs: number | null;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* One entry of the transcript. `type` determines which fields it carries.
|
|
858
|
+
*/
|
|
859
|
+
export interface ThreadItemResource {
|
|
822
860
|
id: string;
|
|
823
861
|
/**
|
|
824
|
-
* The
|
|
862
|
+
* The position in the transcript. Never renumbered. Null for a message waiting in the queue.
|
|
825
863
|
* @nullable
|
|
826
864
|
*/
|
|
827
|
-
|
|
828
|
-
/**
|
|
829
|
-
|
|
830
|
-
|
|
865
|
+
ordinal: number | null;
|
|
866
|
+
/**
|
|
867
|
+
* The turn that wrote this item. Null for messages waiting in the queue.
|
|
868
|
+
* @nullable
|
|
869
|
+
*/
|
|
870
|
+
turnId: string | null;
|
|
871
|
+
type: ThreadItemResourceType;
|
|
872
|
+
/** `queued` is a message sent while the assistant was busy that it has not read yet. */
|
|
873
|
+
status: ThreadItemResourceStatus;
|
|
874
|
+
/** Left out of model requests since a revert. Shown, but marked. */
|
|
831
875
|
reverted: boolean;
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
876
|
+
/** Long reasoning or tool arguments were cut from this list; read the item for all of it. */
|
|
877
|
+
truncated: boolean;
|
|
878
|
+
/** Who wrote an `external_message`. Null for other items. */
|
|
879
|
+
source: ItemSourceResource | null;
|
|
835
880
|
/**
|
|
836
|
-
* The
|
|
837
|
-
* single part, which is most of them.
|
|
838
|
-
*
|
|
839
|
-
* An attachment belongs where it was written, so render these in order rather than putting
|
|
840
|
-
* them all at the end.
|
|
881
|
+
* The Canopy model that produced this item. Null for messages a person or another source sent.
|
|
841
882
|
* @nullable
|
|
842
883
|
*/
|
|
843
|
-
|
|
844
|
-
/**
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
884
|
+
modelId: string | null;
|
|
885
|
+
/**
|
|
886
|
+
* How long the reasoning or the tool call took. Null while it runs and for other items.
|
|
887
|
+
* @nullable
|
|
888
|
+
*/
|
|
889
|
+
durationMs: number | null;
|
|
890
|
+
/**
|
|
891
|
+
* The content, in the order it was written. Text arrives as `append` frames on the realtime
|
|
892
|
+
* stream. An attachment belongs where it was written, so render parts in order. Empty for
|
|
893
|
+
* tool calls; their outcome is in `toolCall.detail` and `toolCall.presentation`.
|
|
894
|
+
*/
|
|
895
|
+
parts: PartResource[];
|
|
896
|
+
attachments: AttachmentResource[];
|
|
897
|
+
/**
|
|
898
|
+
* The `data-*` blocks the client attached to a user message. They are not part of what the
|
|
899
|
+
* person wrote; render the message from `parts` and leave these out of the bubble.
|
|
900
|
+
*/
|
|
901
|
+
clientContext: ClientContextPart[];
|
|
902
|
+
/** The call, for a `tool_call` item. Null for other items. */
|
|
903
|
+
toolCall: ToolCallResource | null;
|
|
904
|
+
createdAt: string;
|
|
848
905
|
}
|
|
849
|
-
export interface
|
|
850
|
-
|
|
851
|
-
|
|
906
|
+
export interface ThreadItemListResponseBody {
|
|
907
|
+
/** Oldest first. */
|
|
908
|
+
items: ThreadItemResource[];
|
|
909
|
+
/**
|
|
910
|
+
* The first ordinal of the window; pass as `before` to read the window above. Null when the window is empty.
|
|
911
|
+
* @nullable
|
|
912
|
+
*/
|
|
913
|
+
startOrdinal: number | null;
|
|
914
|
+
/**
|
|
915
|
+
* The last ordinal of the window; pass as `after` to read the window below. Null when the window is empty.
|
|
916
|
+
* @nullable
|
|
917
|
+
*/
|
|
918
|
+
endOrdinal: number | null;
|
|
919
|
+
hasEarlier: boolean;
|
|
920
|
+
hasLater: boolean;
|
|
921
|
+
/** Messages waiting for the assistant, in the order they were sent. Empty unless the window reaches the end. */
|
|
922
|
+
queued: ThreadItemResource[];
|
|
923
|
+
/**
|
|
924
|
+
* Subscribe to the conversation on /api/v1/realtime from this cursor to receive what is
|
|
925
|
+
* written after this window. Null unless the window reaches the end.
|
|
926
|
+
* @nullable
|
|
927
|
+
*/
|
|
928
|
+
streamCursor: string | null;
|
|
852
929
|
}
|
|
853
|
-
export
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
930
|
+
export interface SendMessageResponseBody {
|
|
931
|
+
/**
|
|
932
|
+
* The turn this message started. Null when it was queued behind a running turn.
|
|
933
|
+
* @nullable
|
|
934
|
+
*/
|
|
935
|
+
turnId: string | null;
|
|
936
|
+
queued: boolean;
|
|
937
|
+
/**
|
|
938
|
+
* How many messages were waiting ahead of this one when it was queued.
|
|
939
|
+
* @minimum 0
|
|
940
|
+
*/
|
|
941
|
+
queuedAhead: number;
|
|
942
|
+
}
|
|
943
|
+
export interface DecideToolCallsRequestBody {
|
|
944
|
+
/**
|
|
945
|
+
* The tool calls awaiting approval, from `pendingAction.itemIds`.
|
|
946
|
+
* @minItems 1
|
|
947
|
+
*/
|
|
948
|
+
itemIds: string[];
|
|
949
|
+
approved: boolean;
|
|
950
|
+
/**
|
|
951
|
+
* Passed to the assistant with a decline, so it can change course.
|
|
952
|
+
* @maxLength 2000
|
|
953
|
+
*/
|
|
954
|
+
reason?: string;
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* A map from question id to the answer.
|
|
958
|
+
*/
|
|
959
|
+
export type AnswerQuestionRequestBodyAnswers = {
|
|
960
|
+
[key: string]: string;
|
|
858
961
|
};
|
|
859
|
-
export interface
|
|
860
|
-
|
|
962
|
+
export interface AnswerQuestionRequestBody {
|
|
963
|
+
/** A map from question id to the answer. */
|
|
964
|
+
answers: AnswerQuestionRequestBodyAnswers;
|
|
965
|
+
}
|
|
966
|
+
export interface ToolResultRequestBody {
|
|
967
|
+
/**
|
|
968
|
+
* The client that declared the action. A result from another client is refused.
|
|
969
|
+
* @minLength 1
|
|
970
|
+
*/
|
|
971
|
+
clientId: string;
|
|
972
|
+
ok: boolean;
|
|
973
|
+
/** What the action produced. At most 64 KiB; use `nextCursor` for more. */
|
|
974
|
+
output?: string;
|
|
975
|
+
/**
|
|
976
|
+
* Why it failed, when `ok` is false. Written for the assistant, which cannot see the screen.
|
|
977
|
+
* @maxLength 2000
|
|
978
|
+
*/
|
|
979
|
+
error?: string;
|
|
980
|
+
/**
|
|
981
|
+
* Pass when there is more to read; the assistant calls again with it.
|
|
982
|
+
* @maxLength 500
|
|
983
|
+
*/
|
|
984
|
+
nextCursor?: string;
|
|
861
985
|
}
|
|
862
|
-
export interface
|
|
986
|
+
export interface CommandResource {
|
|
987
|
+
/** The command without the slash, for example `status`. */
|
|
988
|
+
name: string;
|
|
989
|
+
/** Other names that run the same command. */
|
|
990
|
+
aliases: string[];
|
|
863
991
|
description: string;
|
|
864
|
-
|
|
992
|
+
/** How to write the arguments, for example `<model id>`. Empty when the command takes none. */
|
|
993
|
+
argumentHint: string;
|
|
865
994
|
}
|
|
866
|
-
export interface
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
995
|
+
export interface CommandListResponseBody {
|
|
996
|
+
commands: CommandResource[];
|
|
997
|
+
}
|
|
998
|
+
export interface RunCommandRequestBody {
|
|
999
|
+
/**
|
|
1000
|
+
* The command or one of its aliases, without the slash.
|
|
1001
|
+
* @minLength 1
|
|
1002
|
+
* @maxLength 32
|
|
1003
|
+
*/
|
|
1004
|
+
name: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Everything typed after the command name.
|
|
1007
|
+
* @maxLength 2000
|
|
1008
|
+
*/
|
|
1009
|
+
arguments?: string;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
* The conversation's configuration and resource use, as shown by /status.
|
|
1013
|
+
*/
|
|
1014
|
+
export interface StatusReportResource {
|
|
1015
|
+
threadId: string;
|
|
1016
|
+
modelId: string;
|
|
1017
|
+
/** The model's display name in the Canopy catalogue. Falls back to modelId. */
|
|
1018
|
+
modelName: string;
|
|
1019
|
+
reasoningEffort: ReasoningEffort | null;
|
|
1020
|
+
approvalMode: ApprovalMode;
|
|
1021
|
+
status: ThreadStatus;
|
|
1022
|
+
context: ContextUsageResource;
|
|
1023
|
+
/** Token usage over the whole conversation. */
|
|
1024
|
+
usage: Usage;
|
|
1025
|
+
/** The most recent turn with its own usage. Null before the first message. */
|
|
1026
|
+
lastTurn: ThreadTurnResource | null;
|
|
1027
|
+
}
|
|
1028
|
+
export interface CommandResultResource {
|
|
1029
|
+
/** The command that ran, after resolving aliases. */
|
|
1030
|
+
name: string;
|
|
1031
|
+
/** The result as plain text. */
|
|
1032
|
+
message: string;
|
|
1033
|
+
/** The conversation after the command. */
|
|
1034
|
+
thread: ThreadResource | null;
|
|
1035
|
+
/**
|
|
1036
|
+
* The turn the command started, for example the compaction turn of /compact.
|
|
1037
|
+
* @nullable
|
|
1038
|
+
*/
|
|
1039
|
+
turnId: string | null;
|
|
1040
|
+
/** Set by /status. */
|
|
1041
|
+
status: StatusReportResource | null;
|
|
872
1042
|
}
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
1043
|
+
/**
|
|
1044
|
+
* `inbox` holds the conversations nobody filed. Each caller has one per project.
|
|
1045
|
+
*/
|
|
1046
|
+
export type FolderResourceType = (typeof FolderResourceType)[keyof typeof FolderResourceType];
|
|
1047
|
+
export declare const FolderResourceType: {
|
|
1048
|
+
readonly inbox: "inbox";
|
|
1049
|
+
readonly custom: "custom";
|
|
877
1050
|
};
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
1051
|
+
/**
|
|
1052
|
+
* Unarchived conversations in the folder.
|
|
1053
|
+
*/
|
|
1054
|
+
export interface FolderCountsResource {
|
|
1055
|
+
/** @minimum 0 */
|
|
1056
|
+
total: number;
|
|
1057
|
+
/** @minimum 0 */
|
|
1058
|
+
needsAction: number;
|
|
1059
|
+
/** @minimum 0 */
|
|
1060
|
+
running: number;
|
|
1061
|
+
}
|
|
1062
|
+
export interface FolderResource {
|
|
1063
|
+
id: string;
|
|
1064
|
+
/** `inbox` holds the conversations nobody filed. Each caller has one per project. */
|
|
1065
|
+
type: FolderResourceType;
|
|
1066
|
+
name: string;
|
|
1067
|
+
counts: FolderCountsResource;
|
|
1068
|
+
/** @minimum 0 */
|
|
1069
|
+
orderVersion: number;
|
|
1070
|
+
createdAt: string;
|
|
1071
|
+
updatedAt: string;
|
|
1072
|
+
}
|
|
1073
|
+
export interface FolderListResponseBody {
|
|
1074
|
+
folders: FolderResource[];
|
|
1075
|
+
}
|
|
1076
|
+
export interface CreateFolderRequestBody {
|
|
1077
|
+
/**
|
|
1078
|
+
* @minLength 1
|
|
1079
|
+
* @maxLength 64
|
|
1080
|
+
*/
|
|
1081
|
+
name: string;
|
|
1082
|
+
}
|
|
1083
|
+
export interface UpdateFolderRequestBody {
|
|
1084
|
+
/**
|
|
1085
|
+
* @minLength 1
|
|
1086
|
+
* @maxLength 64
|
|
1087
|
+
*/
|
|
1088
|
+
name: string;
|
|
1089
|
+
}
|
|
1090
|
+
export interface MoveFolderRequestBody {
|
|
1091
|
+
/** @nullable */
|
|
1092
|
+
beforeFolderId: string | null;
|
|
1093
|
+
/** @minimum 0 */
|
|
1094
|
+
expectedVersion: number;
|
|
1095
|
+
}
|
|
1096
|
+
export interface PlaceThreadRequestBody {
|
|
882
1097
|
/** @nullable */
|
|
883
|
-
|
|
884
|
-
kind: WaitResourceKind;
|
|
1098
|
+
beforeThreadId?: string | null;
|
|
885
1099
|
/** @nullable */
|
|
886
|
-
|
|
887
|
-
|
|
1100
|
+
afterThreadId?: string | null;
|
|
1101
|
+
/**
|
|
1102
|
+
* The conversation's `orderVersion`.
|
|
1103
|
+
* @minimum 0
|
|
1104
|
+
*/
|
|
1105
|
+
expectedVersion: number;
|
|
888
1106
|
}
|
|
889
1107
|
/**
|
|
890
|
-
*
|
|
1108
|
+
* `completed` is a one-time task whose run has ended.
|
|
891
1109
|
*/
|
|
892
|
-
export type
|
|
893
|
-
export declare const
|
|
894
|
-
readonly
|
|
895
|
-
readonly
|
|
1110
|
+
export type TaskResourceStatus = (typeof TaskResourceStatus)[keyof typeof TaskResourceStatus];
|
|
1111
|
+
export declare const TaskResourceStatus: {
|
|
1112
|
+
readonly active: "active";
|
|
1113
|
+
readonly paused: "paused";
|
|
896
1114
|
readonly completed: "completed";
|
|
1115
|
+
readonly cancelled: "cancelled";
|
|
897
1116
|
};
|
|
898
|
-
export
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
1117
|
+
export type TaskTriggerType = (typeof TaskTriggerType)[keyof typeof TaskTriggerType];
|
|
1118
|
+
export declare const TaskTriggerType: {
|
|
1119
|
+
readonly now: "now";
|
|
1120
|
+
readonly at: "at";
|
|
1121
|
+
readonly interval: "interval";
|
|
1122
|
+
readonly cron: "cron";
|
|
1123
|
+
};
|
|
1124
|
+
/**
|
|
1125
|
+
* What happens when a run is due while the previous one is still going.
|
|
1126
|
+
*/
|
|
1127
|
+
export type TaskTriggerOverlapPolicy = (typeof TaskTriggerOverlapPolicy)[keyof typeof TaskTriggerOverlapPolicy];
|
|
1128
|
+
export declare const TaskTriggerOverlapPolicy: {
|
|
1129
|
+
readonly skip: "skip";
|
|
1130
|
+
readonly buffer_one: "buffer_one";
|
|
1131
|
+
};
|
|
1132
|
+
/**
|
|
1133
|
+
* When the task runs. `type` determines which fields apply.
|
|
1134
|
+
*/
|
|
1135
|
+
export interface TaskTrigger {
|
|
1136
|
+
type: TaskTriggerType;
|
|
1137
|
+
/**
|
|
1138
|
+
* For `at`.
|
|
1139
|
+
* @nullable
|
|
1140
|
+
*/
|
|
1141
|
+
runAt?: string | null;
|
|
1142
|
+
/**
|
|
1143
|
+
* For `interval`.
|
|
1144
|
+
* @minimum 10
|
|
1145
|
+
* @nullable
|
|
1146
|
+
*/
|
|
1147
|
+
intervalSeconds?: number | null;
|
|
1148
|
+
/**
|
|
1149
|
+
* For `interval`. Runs fall on anchorAt plus whole intervals. Defaults to the creation time.
|
|
1150
|
+
* @nullable
|
|
1151
|
+
*/
|
|
1152
|
+
anchorAt?: string | null;
|
|
1153
|
+
/**
|
|
1154
|
+
* For `cron`. A cron expression evaluated in `timezone`, for example `0 9 * * 1-5`.
|
|
1155
|
+
* @maxLength 128
|
|
1156
|
+
* @nullable
|
|
1157
|
+
*/
|
|
1158
|
+
cron?: string | null;
|
|
1159
|
+
/** An IANA time zone for `cron`. */
|
|
1160
|
+
timezone?: string;
|
|
1161
|
+
/** What happens when a run is due while the previous one is still going. */
|
|
1162
|
+
overlapPolicy?: TaskTriggerOverlapPolicy;
|
|
1163
|
+
/**
|
|
1164
|
+
* How late a missed run may still start, for example after a pause or an outage.
|
|
1165
|
+
* @minimum 10
|
|
1166
|
+
*/
|
|
1167
|
+
catchupSeconds?: number;
|
|
905
1168
|
}
|
|
906
|
-
export
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
1169
|
+
export type TaskActionType = (typeof TaskActionType)[keyof typeof TaskActionType];
|
|
1170
|
+
export declare const TaskActionType: {
|
|
1171
|
+
readonly prompt: "prompt";
|
|
1172
|
+
readonly command: "command";
|
|
1173
|
+
};
|
|
1174
|
+
/**
|
|
1175
|
+
* What a run does. `type` determines which fields apply.
|
|
1176
|
+
*/
|
|
1177
|
+
export interface TaskAction {
|
|
1178
|
+
type: TaskActionType;
|
|
1179
|
+
/**
|
|
1180
|
+
* For `prompt`. Sent to the conversation as a message from the task.
|
|
1181
|
+
* @maxLength 20000
|
|
1182
|
+
* @nullable
|
|
1183
|
+
*/
|
|
1184
|
+
prompt?: string | null;
|
|
1185
|
+
/**
|
|
1186
|
+
* For `command`. The instance that runs it.
|
|
1187
|
+
* @nullable
|
|
1188
|
+
*/
|
|
1189
|
+
instanceId?: string | null;
|
|
1190
|
+
/**
|
|
1191
|
+
* For `command`. A shell command.
|
|
1192
|
+
* @maxLength 20000
|
|
1193
|
+
* @nullable
|
|
1194
|
+
*/
|
|
1195
|
+
command?: string | null;
|
|
1196
|
+
/**
|
|
1197
|
+
* For `command`. The run fails with status timed_out after this long.
|
|
1198
|
+
* @minimum 1
|
|
1199
|
+
* @maximum 3600
|
|
1200
|
+
*/
|
|
1201
|
+
timeoutSeconds?: number;
|
|
1202
|
+
}
|
|
1203
|
+
export type TaskRunResourceStatus = (typeof TaskRunResourceStatus)[keyof typeof TaskRunResourceStatus];
|
|
1204
|
+
export declare const TaskRunResourceStatus: {
|
|
1205
|
+
readonly queued: "queued";
|
|
1206
|
+
readonly running: "running";
|
|
1207
|
+
readonly completed: "completed";
|
|
1208
|
+
readonly failed: "failed";
|
|
1209
|
+
readonly cancelled: "cancelled";
|
|
1210
|
+
readonly timed_out: "timed_out";
|
|
1211
|
+
};
|
|
1212
|
+
export interface TaskRunResource {
|
|
1213
|
+
id: string;
|
|
1214
|
+
taskId: string;
|
|
1215
|
+
status: TaskRunResourceStatus;
|
|
911
1216
|
/** @nullable */
|
|
912
|
-
|
|
913
|
-
status: string;
|
|
914
|
-
stream: StreamResource | null;
|
|
915
|
-
turn: TurnResource | null;
|
|
916
|
-
/** The assistant's checklist for the work in this conversation, in the order it intends to do it. Empty when it has not written one — short tasks do not get a list. It is rewritten in full each time, so what is here is the current state. */
|
|
917
|
-
todos?: TodoResource[];
|
|
1217
|
+
startedAt: string | null;
|
|
918
1218
|
/** @nullable */
|
|
919
|
-
|
|
920
|
-
|
|
1219
|
+
finishedAt: string | null;
|
|
1220
|
+
/**
|
|
1221
|
+
* For commands. Null until the command exits.
|
|
1222
|
+
* @nullable
|
|
1223
|
+
*/
|
|
1224
|
+
exitCode: number | null;
|
|
1225
|
+
/**
|
|
1226
|
+
* The last 16 KiB of a command's output. Empty for prompts; null in lists, read the run for it.
|
|
1227
|
+
* @nullable
|
|
1228
|
+
*/
|
|
1229
|
+
output: string | null;
|
|
1230
|
+
/**
|
|
1231
|
+
* Why the run failed. Null unless status is failed.
|
|
1232
|
+
* @nullable
|
|
1233
|
+
*/
|
|
1234
|
+
errorCode: string | null;
|
|
921
1235
|
}
|
|
922
|
-
export
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
1236
|
+
export interface TaskResource {
|
|
1237
|
+
id: string;
|
|
1238
|
+
/** The conversation the task reports to. */
|
|
1239
|
+
threadId: string;
|
|
1240
|
+
name: string;
|
|
1241
|
+
/** `completed` is a one-time task whose run has ended. */
|
|
1242
|
+
status: TaskResourceStatus;
|
|
1243
|
+
trigger: TaskTrigger;
|
|
1244
|
+
action: TaskAction;
|
|
931
1245
|
/**
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
* Non-null requires allowModelSelection. A disallowed, retired or removed Canopy id is retained and uses the default when needed. The preference can be changed while a turn is running or waiting, but that turn and messages queued into it keep their captured model choices.
|
|
935
|
-
* @minLength 1
|
|
936
|
-
* @maxLength 128
|
|
1246
|
+
* When the trigger starts the next run. Null when it will not.
|
|
937
1247
|
* @nullable
|
|
938
1248
|
*/
|
|
939
|
-
|
|
1249
|
+
nextRunAt: string | null;
|
|
1250
|
+
lastRun: TaskRunResource | null;
|
|
1251
|
+
createdAt: string;
|
|
1252
|
+
updatedAt: string;
|
|
1253
|
+
}
|
|
1254
|
+
export interface CreateTaskRequestBody {
|
|
940
1255
|
/**
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
* Filing does not move the conversation in the list. The order answers "which conversation has something new in it", and putting one away is not that.
|
|
1256
|
+
* @minLength 1
|
|
944
1257
|
* @maxLength 64
|
|
945
|
-
* @nullable
|
|
946
1258
|
*/
|
|
947
|
-
|
|
1259
|
+
threadId: string;
|
|
948
1260
|
/**
|
|
949
|
-
* Rename this conversation.
|
|
950
|
-
*
|
|
951
|
-
* A conversation names itself: the first message gives it a working title, and the assistant replaces that with a better one once it has answered. Setting this stops both — a name somebody chose is never overwritten by one that was generated.
|
|
952
|
-
*
|
|
953
|
-
* Renaming does not move the conversation in the list. The order answers "which conversation has something new in it", and editing a title is not that.
|
|
954
1261
|
* @minLength 1
|
|
955
|
-
* @maxLength
|
|
1262
|
+
* @maxLength 128
|
|
956
1263
|
*/
|
|
957
|
-
|
|
1264
|
+
name: string;
|
|
1265
|
+
trigger: TaskTrigger;
|
|
1266
|
+
action: TaskAction;
|
|
958
1267
|
}
|
|
959
|
-
export interface
|
|
960
|
-
|
|
961
|
-
|
|
1268
|
+
export interface UpdateTaskRequestBody {
|
|
1269
|
+
/**
|
|
1270
|
+
* @minLength 1
|
|
1271
|
+
* @maxLength 128
|
|
1272
|
+
*/
|
|
1273
|
+
name?: string;
|
|
1274
|
+
trigger?: TaskTrigger;
|
|
1275
|
+
action?: TaskAction;
|
|
1276
|
+
}
|
|
1277
|
+
export type SearchTasksRequestBodyStatus = (typeof SearchTasksRequestBodyStatus)[keyof typeof SearchTasksRequestBodyStatus];
|
|
1278
|
+
export declare const SearchTasksRequestBodyStatus: {
|
|
1279
|
+
readonly active: "active";
|
|
1280
|
+
readonly paused: "paused";
|
|
1281
|
+
readonly completed: "completed";
|
|
1282
|
+
readonly cancelled: "cancelled";
|
|
1283
|
+
};
|
|
1284
|
+
export type SearchTasksRequestBodyTriggerType = (typeof SearchTasksRequestBodyTriggerType)[keyof typeof SearchTasksRequestBodyTriggerType];
|
|
1285
|
+
export declare const SearchTasksRequestBodyTriggerType: {
|
|
1286
|
+
readonly now: "now";
|
|
1287
|
+
readonly at: "at";
|
|
1288
|
+
readonly interval: "interval";
|
|
1289
|
+
readonly cron: "cron";
|
|
1290
|
+
};
|
|
1291
|
+
export type SearchTasksRequestBodyActionType = (typeof SearchTasksRequestBodyActionType)[keyof typeof SearchTasksRequestBodyActionType];
|
|
1292
|
+
export declare const SearchTasksRequestBodyActionType: {
|
|
1293
|
+
readonly prompt: "prompt";
|
|
1294
|
+
readonly command: "command";
|
|
1295
|
+
};
|
|
1296
|
+
export interface SearchTasksRequestBody {
|
|
1297
|
+
/**
|
|
1298
|
+
* Only the tasks that report to this conversation.
|
|
1299
|
+
* @maxLength 64
|
|
1300
|
+
*/
|
|
1301
|
+
threadId?: string;
|
|
1302
|
+
status?: SearchTasksRequestBodyStatus;
|
|
1303
|
+
triggerType?: SearchTasksRequestBodyTriggerType;
|
|
1304
|
+
actionType?: SearchTasksRequestBodyActionType;
|
|
1305
|
+
/** @maxLength 1024 */
|
|
1306
|
+
cursor?: string;
|
|
1307
|
+
/**
|
|
1308
|
+
* @minimum 1
|
|
1309
|
+
* @maximum 200
|
|
1310
|
+
*/
|
|
1311
|
+
limit?: number;
|
|
1312
|
+
}
|
|
1313
|
+
export interface TaskListResponseBody {
|
|
1314
|
+
tasks: TaskResource[];
|
|
1315
|
+
/** @nullable */
|
|
1316
|
+
nextCursor: string | null;
|
|
1317
|
+
}
|
|
1318
|
+
export interface TaskRunListResponseBody {
|
|
1319
|
+
runs: TaskRunResource[];
|
|
1320
|
+
/** @nullable */
|
|
1321
|
+
nextCursor: string | null;
|
|
1322
|
+
}
|
|
1323
|
+
/**
|
|
1324
|
+
* `user` when it is the caller's choice, `catalog` when it comes from the Canopy catalogue.
|
|
1325
|
+
*/
|
|
1326
|
+
export type DefaultModelResourceSource = (typeof DefaultModelResourceSource)[keyof typeof DefaultModelResourceSource];
|
|
1327
|
+
export declare const DefaultModelResourceSource: {
|
|
1328
|
+
readonly user: "user";
|
|
1329
|
+
readonly catalog: "catalog";
|
|
1330
|
+
};
|
|
1331
|
+
/**
|
|
1332
|
+
* The model and effort a new conversation gets when it names none.
|
|
1333
|
+
*/
|
|
1334
|
+
export interface DefaultModelResource {
|
|
1335
|
+
/**
|
|
1336
|
+
* Null when the catalogue has no model that can run an agent.
|
|
1337
|
+
* @nullable
|
|
1338
|
+
*/
|
|
1339
|
+
modelId: string | null;
|
|
1340
|
+
reasoningEffort: ReasoningEffort | null;
|
|
1341
|
+
/** `user` when it is the caller's choice, `catalog` when it comes from the Canopy catalogue. */
|
|
1342
|
+
source: DefaultModelResourceSource;
|
|
1343
|
+
}
|
|
1344
|
+
export interface SettingsResource {
|
|
1345
|
+
/**
|
|
1346
|
+
* The caller's choice. Null when none is set.
|
|
1347
|
+
* @nullable
|
|
1348
|
+
*/
|
|
1349
|
+
defaultModelId: string | null;
|
|
1350
|
+
/** The caller's choice. Null when none is set. */
|
|
1351
|
+
defaultReasoningEffort: ReasoningEffort | null;
|
|
1352
|
+
defaultModel: DefaultModelResource;
|
|
1353
|
+
}
|
|
1354
|
+
export interface UpdateSettingsRequestBody {
|
|
1355
|
+
/**
|
|
1356
|
+
* @minLength 1
|
|
1357
|
+
* @maxLength 128
|
|
1358
|
+
* @nullable
|
|
1359
|
+
*/
|
|
1360
|
+
defaultModelId?: string | null;
|
|
1361
|
+
defaultReasoningEffort?: ReasoningEffort | null;
|
|
1362
|
+
}
|
|
1363
|
+
export interface RealtimeTicketResource {
|
|
1364
|
+
/** The WebSocket address, absolute or relative to the API origin. */
|
|
1365
|
+
url: string;
|
|
1366
|
+
ticket: string;
|
|
1367
|
+
expiresAt: string;
|
|
1368
|
+
}
|
|
1369
|
+
export type RealtimeClientMessageType = (typeof RealtimeClientMessageType)[keyof typeof RealtimeClientMessageType];
|
|
1370
|
+
export declare const RealtimeClientMessageType: {
|
|
1371
|
+
readonly subscribe: "subscribe";
|
|
1372
|
+
readonly unsubscribe: "unsubscribe";
|
|
1373
|
+
readonly ping: "ping";
|
|
1374
|
+
};
|
|
1375
|
+
/**
|
|
1376
|
+
* A message from the client. `type` determines which fields apply.
|
|
1377
|
+
*/
|
|
1378
|
+
export interface RealtimeClientMessage {
|
|
1379
|
+
type: RealtimeClientMessageType;
|
|
1380
|
+
/**
|
|
1381
|
+
* `workspace` or `thread:{id}`. For subscribe and unsubscribe.
|
|
1382
|
+
* @maxLength 128
|
|
1383
|
+
*/
|
|
1384
|
+
topic?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* For a `thread:{id}` subscription, the `streamCursor` to replay from.
|
|
1387
|
+
* @maxLength 128
|
|
1388
|
+
*/
|
|
1389
|
+
cursor?: string;
|
|
1390
|
+
}
|
|
1391
|
+
export type RealtimeServerMessageType = (typeof RealtimeServerMessageType)[keyof typeof RealtimeServerMessageType];
|
|
1392
|
+
export declare const RealtimeServerMessageType: {
|
|
1393
|
+
readonly subscribed: "subscribed";
|
|
1394
|
+
readonly unsubscribed: "unsubscribed";
|
|
1395
|
+
readonly threadupdated: "thread.updated";
|
|
1396
|
+
readonly threaddeleted: "thread.deleted";
|
|
1397
|
+
readonly turnupdated: "turn.updated";
|
|
1398
|
+
readonly folderupdated: "folder.updated";
|
|
1399
|
+
readonly folderdeleted: "folder.deleted";
|
|
1400
|
+
readonly taskupdated: "task.updated";
|
|
1401
|
+
readonly taskdeleted: "task.deleted";
|
|
1402
|
+
readonly itemframe: "item.frame";
|
|
1403
|
+
readonly resync: "resync";
|
|
1404
|
+
readonly error: "error";
|
|
1405
|
+
readonly pong: "pong";
|
|
1406
|
+
};
|
|
1407
|
+
export type ItemFrameOp = (typeof ItemFrameOp)[keyof typeof ItemFrameOp];
|
|
1408
|
+
export declare const ItemFrameOp: {
|
|
1409
|
+
readonly add: "add";
|
|
1410
|
+
readonly set: "set";
|
|
1411
|
+
readonly append: "append";
|
|
1412
|
+
};
|
|
1413
|
+
/**
|
|
1414
|
+
* An edit to the transcript as returned by list-thread-items. `path` is a JSON Pointer under
|
|
1415
|
+
* `/items`: `add` appends `value` to `/items` or replaces the item with the same id, `set`
|
|
1416
|
+
* replaces the value at `path`, and `append` concatenates the string `value` to the string at
|
|
1417
|
+
* `path`, which is how answer text streams in.
|
|
1418
|
+
*/
|
|
1419
|
+
export interface ItemFrame {
|
|
1420
|
+
path: string;
|
|
1421
|
+
op: ItemFrameOp;
|
|
1422
|
+
value: unknown;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* A message from the server. `type` determines which fields apply:
|
|
1426
|
+
*
|
|
1427
|
+
* - `subscribed` / `unsubscribed` — `topic`
|
|
1428
|
+
* - `thread.updated` — `thread`; `thread.deleted` — `threadId`
|
|
1429
|
+
* - `turn.updated` — `turn`, sent while a turn runs so its usage can be shown live
|
|
1430
|
+
* - `folder.updated` — `folder`; `folder.deleted` — `folderId`
|
|
1431
|
+
* - `task.updated` — `task`; `task.deleted` — `taskId`
|
|
1432
|
+
* - `item.frame` — `threadId`, `cursor` and `frame`, an edit to the transcript
|
|
1433
|
+
* - `resync` — `topic`; the client lost events and reads the current state again
|
|
1434
|
+
* - `error` — `code` and `message`
|
|
1435
|
+
* - `pong`
|
|
1436
|
+
*/
|
|
1437
|
+
export interface RealtimeServerMessage {
|
|
1438
|
+
type: RealtimeServerMessageType;
|
|
1439
|
+
topic?: string;
|
|
1440
|
+
thread?: ThreadResource;
|
|
1441
|
+
threadId?: string;
|
|
1442
|
+
turn?: ThreadTurnResource;
|
|
1443
|
+
folder?: FolderResource;
|
|
1444
|
+
folderId?: string;
|
|
1445
|
+
task?: TaskResource;
|
|
1446
|
+
taskId?: string;
|
|
1447
|
+
/** For `item.frame`. Resubscribe from this cursor to continue after a reconnect. */
|
|
1448
|
+
cursor?: string;
|
|
1449
|
+
frame?: ItemFrame;
|
|
1450
|
+
code?: string;
|
|
1451
|
+
message?: string;
|
|
1452
|
+
}
|
|
1453
|
+
/**
|
|
1454
|
+
* Both directions of the WebSocket protocol, for code generation.
|
|
1455
|
+
*/
|
|
1456
|
+
export interface RealtimeExchange {
|
|
1457
|
+
client: RealtimeClientMessage;
|
|
1458
|
+
server: RealtimeServerMessage;
|
|
1459
|
+
}
|
|
1460
|
+
/**
|
|
1461
|
+
* How the assistant will see this file.
|
|
1462
|
+
*
|
|
1463
|
+
* - `image` — read directly, and only by models that accept image input
|
|
1464
|
+
* - `text` — placed inline in the message when small enough, otherwise read on demand
|
|
1465
|
+
* - `binary` — never read directly; the assistant downloads it onto a cloud instance to work with it
|
|
1466
|
+
*/
|
|
1467
|
+
export type UploadedResourceType = (typeof UploadedResourceType)[keyof typeof UploadedResourceType];
|
|
1468
|
+
export declare const UploadedResourceType: {
|
|
1469
|
+
readonly image: "image";
|
|
1470
|
+
readonly text: "text";
|
|
1471
|
+
readonly binary: "binary";
|
|
1472
|
+
};
|
|
1473
|
+
export interface UploadedResource {
|
|
1474
|
+
/** Size of what was stored. For an image that has been resized, this is the resized size, not what was uploaded. */
|
|
1475
|
+
byteSize: number;
|
|
1476
|
+
/**
|
|
1477
|
+
* When this upload gets cleared if no message ever references it. Sending a message with this id makes it permanent and this stops applying — a file that belongs to a conversation is kept as long as the conversation is.
|
|
1478
|
+
*
|
|
1479
|
+
* It is here so the editor can say so before it happens. An attachment chip that quietly stops working a week later reads as a bug, and the person who hits it has no way to tell that what they are seeing is a draft being collected.
|
|
1480
|
+
*/
|
|
1481
|
+
draftExpiresAt: string;
|
|
1482
|
+
filename: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* Null unless type is image.
|
|
1485
|
+
* @nullable
|
|
1486
|
+
*/
|
|
1487
|
+
height: number | null;
|
|
1488
|
+
id: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* How the assistant will see this file.
|
|
1491
|
+
*
|
|
1492
|
+
* - `image` — read directly, and only by models that accept image input
|
|
1493
|
+
* - `text` — placed inline in the message when small enough, otherwise read on demand
|
|
1494
|
+
* - `binary` — never read directly; the assistant downloads it onto a cloud instance to work with it
|
|
1495
|
+
*/
|
|
1496
|
+
type: UploadedResourceType;
|
|
1497
|
+
/**
|
|
1498
|
+
* Null unless type is image.
|
|
1499
|
+
* @nullable
|
|
1500
|
+
*/
|
|
1501
|
+
width: number | null;
|
|
1502
|
+
}
|
|
1503
|
+
export interface UploadConfigurationResource {
|
|
1504
|
+
enabled: boolean;
|
|
1505
|
+
policyId: string;
|
|
1506
|
+
maxFileBytes: number;
|
|
1507
|
+
maxImageBytes: number;
|
|
1508
|
+
partSizeBytes: number;
|
|
1509
|
+
expirySeconds: number;
|
|
1510
|
+
}
|
|
1511
|
+
export interface UploadPartResource {
|
|
1512
|
+
number: number;
|
|
1513
|
+
byteSize: number;
|
|
1514
|
+
etag: string;
|
|
1515
|
+
}
|
|
1516
|
+
export interface UploadResource {
|
|
1517
|
+
id: string;
|
|
1518
|
+
filename: string;
|
|
1519
|
+
byteSize: number;
|
|
1520
|
+
partSizeBytes: number;
|
|
1521
|
+
policyId: string;
|
|
1522
|
+
expiresAt: string;
|
|
1523
|
+
status: string;
|
|
1524
|
+
/** @nullable */
|
|
1525
|
+
attachmentId: string | null;
|
|
1526
|
+
parts: UploadPartResource[];
|
|
1527
|
+
}
|
|
1528
|
+
export interface UploadListResponseBody {
|
|
1529
|
+
uploads: UploadResource[];
|
|
1530
|
+
}
|
|
1531
|
+
export interface CreateUploadRequestBody {
|
|
1532
|
+
/**
|
|
1533
|
+
* @minLength 1
|
|
1534
|
+
* @maxLength 64
|
|
1535
|
+
*/
|
|
1536
|
+
requestId: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* @minLength 1
|
|
1539
|
+
* @maxLength 255
|
|
1540
|
+
*/
|
|
1541
|
+
filename: string;
|
|
1542
|
+
byteSize: number;
|
|
1543
|
+
policyId: string;
|
|
1544
|
+
maxFileBytes: number;
|
|
1545
|
+
partSizeBytes: number;
|
|
1546
|
+
}
|
|
1547
|
+
export interface UpdateUploadRequestBody {
|
|
1548
|
+
/**
|
|
1549
|
+
* @minLength 1
|
|
1550
|
+
* @maxLength 255
|
|
1551
|
+
*/
|
|
1552
|
+
filename: string;
|
|
1553
|
+
}
|
|
1554
|
+
export interface CompleteUploadRequestBody {
|
|
1555
|
+
policyId: string;
|
|
1556
|
+
}
|
|
1557
|
+
export interface MemoryResource {
|
|
1558
|
+
/** The fact itself */
|
|
1559
|
+
body: string;
|
|
1560
|
+
createdAt: string;
|
|
1561
|
+
id: string;
|
|
1562
|
+
/** The name the assistant gave this fact; it overwrites or deletes its own entries by that name */
|
|
1563
|
+
name: string;
|
|
1564
|
+
/** Which conversation the assistant learned it in. That conversation may since have been deleted */
|
|
1565
|
+
sourceThreadId?: string;
|
|
1566
|
+
updatedAt: string;
|
|
1567
|
+
}
|
|
1568
|
+
export interface MemoryListResponseBody {
|
|
1569
|
+
items: MemoryResource[];
|
|
1570
|
+
}
|
|
1571
|
+
/**
|
|
1572
|
+
* Path to contents, `SKILL.md` among them. Only returned by `get-skill`; the list leaves it out.
|
|
1573
|
+
* @nullable
|
|
1574
|
+
*/
|
|
1575
|
+
export type SkillResourceFiles = {
|
|
1576
|
+
[key: string]: string;
|
|
1577
|
+
} | null;
|
|
1578
|
+
/**
|
|
1579
|
+
* `builtin` — provided by the platform and read-only here.
|
|
1580
|
+
* `project` — written for this project and editable by anyone in it.
|
|
1581
|
+
*/
|
|
1582
|
+
export type SkillResourceOrigin = (typeof SkillResourceOrigin)[keyof typeof SkillResourceOrigin];
|
|
1583
|
+
export declare const SkillResourceOrigin: {
|
|
1584
|
+
readonly builtin: "builtin";
|
|
1585
|
+
readonly project: "project";
|
|
1586
|
+
};
|
|
1587
|
+
export interface SkillResource {
|
|
1588
|
+
/**
|
|
1589
|
+
* True when the assistant wrote this skill during a conversation rather than a person
|
|
1590
|
+
* writing it here.
|
|
1591
|
+
*
|
|
1592
|
+
* Which conversation is deliberately not returned: skills are shared across the project
|
|
1593
|
+
* while conversations belong to one person, so naming one would tell everybody in the
|
|
1594
|
+
* project that a particular colleague had it.
|
|
1595
|
+
*/
|
|
1596
|
+
authoredByAssistant: boolean;
|
|
1597
|
+
/** Why the assistant would open this skill. It sits in every request, so it is the one field worth writing carefully. */
|
|
1598
|
+
description: string;
|
|
1599
|
+
enabled: boolean;
|
|
1600
|
+
/**
|
|
1601
|
+
* Path to contents, `SKILL.md` among them. Only returned by `get-skill`; the list leaves it out.
|
|
1602
|
+
* @nullable
|
|
1603
|
+
*/
|
|
1604
|
+
files?: SkillResourceFiles;
|
|
1605
|
+
name: string;
|
|
1606
|
+
/**
|
|
1607
|
+
* `builtin` — provided by the platform and read-only here.
|
|
1608
|
+
* `project` — written for this project and editable by anyone in it.
|
|
1609
|
+
*/
|
|
1610
|
+
origin: SkillResourceOrigin;
|
|
1611
|
+
/** @nullable */
|
|
1612
|
+
shortDescription: string | null;
|
|
1613
|
+
/**
|
|
1614
|
+
* Null for built-in skills, which have no edit history here.
|
|
1615
|
+
* @nullable
|
|
1616
|
+
*/
|
|
1617
|
+
updatedAt: string | null;
|
|
1618
|
+
}
|
|
1619
|
+
export interface SkillListResponseBody {
|
|
1620
|
+
skills: SkillResource[];
|
|
1621
|
+
}
|
|
1622
|
+
/**
|
|
1623
|
+
* Path to contents. `SKILL.md` is required; anything else it references goes alongside it.
|
|
1624
|
+
*
|
|
1625
|
+
* Paths are relative to the skill and cannot leave it. At most 32 files, 256 KiB each and
|
|
1626
|
+
* 1 MiB in total.
|
|
1627
|
+
*/
|
|
1628
|
+
export type SkillRequestBodyFiles = {
|
|
1629
|
+
[key: string]: string;
|
|
1630
|
+
};
|
|
1631
|
+
export interface SkillRequestBody {
|
|
1632
|
+
/**
|
|
1633
|
+
* Why the assistant would open this skill. It sits in every request; write it as the answer to "when do I need this", not "what does it contain".
|
|
1634
|
+
* @minLength 1
|
|
1635
|
+
* @maxLength 1024
|
|
1636
|
+
*/
|
|
1637
|
+
description: string;
|
|
1638
|
+
enabled?: boolean;
|
|
1639
|
+
/**
|
|
1640
|
+
* Path to contents. `SKILL.md` is required; anything else it references goes alongside it.
|
|
1641
|
+
*
|
|
1642
|
+
* Paths are relative to the skill and cannot leave it. At most 32 files, 256 KiB each and
|
|
1643
|
+
* 1 MiB in total.
|
|
1644
|
+
*/
|
|
1645
|
+
files: SkillRequestBodyFiles;
|
|
1646
|
+
/**
|
|
1647
|
+
* Also how the assistant refers to it, so renaming is deleting and writing again.
|
|
1648
|
+
* @minLength 1
|
|
1649
|
+
* @maxLength 64
|
|
1650
|
+
*/
|
|
1651
|
+
name: string;
|
|
1652
|
+
/** @maxLength 1024 */
|
|
1653
|
+
shortDescription?: string;
|
|
1654
|
+
}
|
|
1655
|
+
export interface SkillEnabledRequestBody {
|
|
1656
|
+
enabled: boolean;
|
|
1657
|
+
}
|
|
1658
|
+
export type BindingResourceConnectionStatus = (typeof BindingResourceConnectionStatus)[keyof typeof BindingResourceConnectionStatus];
|
|
1659
|
+
export declare const BindingResourceConnectionStatus: {
|
|
1660
|
+
readonly logged_out: "logged_out";
|
|
1661
|
+
readonly qr_pending: "qr_pending";
|
|
1662
|
+
readonly online: "online";
|
|
1663
|
+
readonly expired: "expired";
|
|
1664
|
+
};
|
|
1665
|
+
export type BindingResourceStatus = (typeof BindingResourceStatus)[keyof typeof BindingResourceStatus];
|
|
1666
|
+
export declare const BindingResourceStatus: {
|
|
1667
|
+
readonly pending: "pending";
|
|
1668
|
+
readonly active: "active";
|
|
1669
|
+
readonly revoked: "revoked";
|
|
1670
|
+
};
|
|
1671
|
+
export interface BindingResource {
|
|
1672
|
+
channelId: string;
|
|
1673
|
+
connectionStatus: BindingResourceConnectionStatus;
|
|
1674
|
+
createdAt: string;
|
|
1675
|
+
id: string;
|
|
1676
|
+
peerName: string;
|
|
1677
|
+
platform: string;
|
|
1678
|
+
status: BindingResourceStatus;
|
|
1679
|
+
/** @nullable */
|
|
1680
|
+
verifiedAt: string | null;
|
|
1681
|
+
}
|
|
1682
|
+
export interface LengthAwarePageBindingResource {
|
|
1683
|
+
/** The entries on this page */
|
|
1684
|
+
items: BindingResource[];
|
|
1685
|
+
/** The page size, echoing what was requested */
|
|
1686
|
+
limit: number;
|
|
1687
|
+
/** How many were skipped, echoing what was requested */
|
|
1688
|
+
offset: number;
|
|
1689
|
+
/** How many match in total, not just on this page */
|
|
1690
|
+
total: number;
|
|
1691
|
+
}
|
|
1692
|
+
/**
|
|
1693
|
+
* How far this channel is from working. Only `online` receives messages and can issue binding codes
|
|
1694
|
+
*/
|
|
1695
|
+
export type ChannelResourceConnectionStatus = (typeof ChannelResourceConnectionStatus)[keyof typeof ChannelResourceConnectionStatus];
|
|
1696
|
+
export declare const ChannelResourceConnectionStatus: {
|
|
1697
|
+
readonly logged_out: "logged_out";
|
|
1698
|
+
readonly qr_pending: "qr_pending";
|
|
1699
|
+
readonly online: "online";
|
|
1700
|
+
readonly expired: "expired";
|
|
1701
|
+
};
|
|
1702
|
+
/**
|
|
1703
|
+
* The state of the long-lived connection right now. Always `stopped` for webhook platforms
|
|
1704
|
+
*/
|
|
1705
|
+
export type ChannelResourceRuntimeStatus = (typeof ChannelResourceRuntimeStatus)[keyof typeof ChannelResourceRuntimeStatus];
|
|
1706
|
+
export declare const ChannelResourceRuntimeStatus: {
|
|
1707
|
+
readonly stopped: "stopped";
|
|
1708
|
+
readonly running: "running";
|
|
1709
|
+
};
|
|
1710
|
+
export type ChannelResourceSenderPolicy = (typeof ChannelResourceSenderPolicy)[keyof typeof ChannelResourceSenderPolicy];
|
|
1711
|
+
export declare const ChannelResourceSenderPolicy: {
|
|
1712
|
+
readonly bound_only: "bound_only";
|
|
1713
|
+
readonly open: "open";
|
|
1714
|
+
};
|
|
1715
|
+
export type ChannelResourceStatus = (typeof ChannelResourceStatus)[keyof typeof ChannelResourceStatus];
|
|
1716
|
+
export declare const ChannelResourceStatus: {
|
|
1717
|
+
readonly active: "active";
|
|
1718
|
+
readonly suspended: "suspended";
|
|
1719
|
+
readonly disabled: "disabled";
|
|
1720
|
+
};
|
|
1721
|
+
export interface ChannelResource {
|
|
1722
|
+
/** @nullable */
|
|
1723
|
+
allowFrom: string[] | null;
|
|
1724
|
+
/** How far this channel is from working. Only `online` receives messages and can issue binding codes */
|
|
1725
|
+
connectionStatus: ChannelResourceConnectionStatus;
|
|
1726
|
+
createdAt: string;
|
|
1727
|
+
id: string;
|
|
1728
|
+
name: string;
|
|
1729
|
+
platform: string;
|
|
1730
|
+
/** The state of the long-lived connection right now. Always `stopped` for webhook platforms */
|
|
1731
|
+
runtimeStatus: ChannelResourceRuntimeStatus;
|
|
1732
|
+
senderPolicy: ChannelResourceSenderPolicy;
|
|
1733
|
+
status: ChannelResourceStatus;
|
|
1734
|
+
updatedAt: string;
|
|
1735
|
+
/** The webhook path, for gateway configuration and for diagnosis */
|
|
1736
|
+
webhookPath: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* The webhook address to paste into that platform's console. Null when the deployment declares no public entry point
|
|
1739
|
+
* @nullable
|
|
1740
|
+
*/
|
|
1741
|
+
webhookUrl: string | null;
|
|
1742
|
+
}
|
|
1743
|
+
export interface LengthAwarePageChannelResource {
|
|
1744
|
+
/** The entries on this page */
|
|
1745
|
+
items: ChannelResource[];
|
|
1746
|
+
/** The page size, echoing what was requested */
|
|
1747
|
+
limit: number;
|
|
1748
|
+
/** How many were skipped, echoing what was requested */
|
|
1749
|
+
offset: number;
|
|
1750
|
+
/** How many match in total, not just on this page */
|
|
1751
|
+
total: number;
|
|
1752
|
+
}
|
|
1753
|
+
/**
|
|
1754
|
+
* Credentials for that platform. Write-only: they cannot be read back after creation
|
|
1755
|
+
*/
|
|
1756
|
+
export type CreateChannelRequestBodyCredentials = {
|
|
1757
|
+
[key: string]: string;
|
|
1758
|
+
};
|
|
1759
|
+
export type CreateChannelRequestBodySenderPolicy = (typeof CreateChannelRequestBodySenderPolicy)[keyof typeof CreateChannelRequestBodySenderPolicy];
|
|
1760
|
+
export declare const CreateChannelRequestBodySenderPolicy: {
|
|
1761
|
+
readonly bound_only: "bound_only";
|
|
1762
|
+
readonly open: "open";
|
|
1763
|
+
};
|
|
1764
|
+
export interface CreateChannelRequestBody {
|
|
1765
|
+
/** @nullable */
|
|
1766
|
+
allowFrom?: string[] | null;
|
|
1767
|
+
/** Credentials for that platform. Write-only: they cannot be read back after creation */
|
|
1768
|
+
credentials?: CreateChannelRequestBodyCredentials;
|
|
1769
|
+
/**
|
|
1770
|
+
* @minLength 1
|
|
1771
|
+
* @maxLength 128
|
|
1772
|
+
*/
|
|
1773
|
+
name: string;
|
|
1774
|
+
/** @minLength 1 */
|
|
1775
|
+
platform: string;
|
|
1776
|
+
senderPolicy?: CreateChannelRequestBodySenderPolicy;
|
|
1777
|
+
/** Required for platforms that generate the secret themselves (secretSource=supplied). Must be absent for `generated` ones, where the secret we make is returned once in webhookSecret on this response */
|
|
1778
|
+
webhookSecret?: string;
|
|
1779
|
+
}
|
|
1780
|
+
/**
|
|
1781
|
+
* How far this channel is from working. Only `online` receives messages and can issue binding codes
|
|
1782
|
+
*/
|
|
1783
|
+
export type ChannelWithSecretResponseBodyConnectionStatus = (typeof ChannelWithSecretResponseBodyConnectionStatus)[keyof typeof ChannelWithSecretResponseBodyConnectionStatus];
|
|
1784
|
+
export declare const ChannelWithSecretResponseBodyConnectionStatus: {
|
|
1785
|
+
readonly logged_out: "logged_out";
|
|
1786
|
+
readonly qr_pending: "qr_pending";
|
|
1787
|
+
readonly online: "online";
|
|
1788
|
+
readonly expired: "expired";
|
|
1789
|
+
};
|
|
1790
|
+
/**
|
|
1791
|
+
* The state of the long-lived connection right now. Always `stopped` for webhook platforms
|
|
1792
|
+
*/
|
|
1793
|
+
export type ChannelWithSecretResponseBodyRuntimeStatus = (typeof ChannelWithSecretResponseBodyRuntimeStatus)[keyof typeof ChannelWithSecretResponseBodyRuntimeStatus];
|
|
1794
|
+
export declare const ChannelWithSecretResponseBodyRuntimeStatus: {
|
|
1795
|
+
readonly stopped: "stopped";
|
|
1796
|
+
readonly running: "running";
|
|
1797
|
+
};
|
|
1798
|
+
export type ChannelWithSecretResponseBodySenderPolicy = (typeof ChannelWithSecretResponseBodySenderPolicy)[keyof typeof ChannelWithSecretResponseBodySenderPolicy];
|
|
1799
|
+
export declare const ChannelWithSecretResponseBodySenderPolicy: {
|
|
1800
|
+
readonly bound_only: "bound_only";
|
|
1801
|
+
readonly open: "open";
|
|
1802
|
+
};
|
|
1803
|
+
export type ChannelWithSecretResponseBodyStatus = (typeof ChannelWithSecretResponseBodyStatus)[keyof typeof ChannelWithSecretResponseBodyStatus];
|
|
1804
|
+
export declare const ChannelWithSecretResponseBodyStatus: {
|
|
1805
|
+
readonly active: "active";
|
|
1806
|
+
readonly suspended: "suspended";
|
|
1807
|
+
readonly disabled: "disabled";
|
|
1808
|
+
};
|
|
1809
|
+
export interface ChannelWithSecretResponseBody {
|
|
1810
|
+
/** @nullable */
|
|
1811
|
+
allowFrom: string[] | null;
|
|
1812
|
+
/** How far this channel is from working. Only `online` receives messages and can issue binding codes */
|
|
1813
|
+
connectionStatus: ChannelWithSecretResponseBodyConnectionStatus;
|
|
1814
|
+
createdAt: string;
|
|
1815
|
+
id: string;
|
|
1816
|
+
name: string;
|
|
1817
|
+
platform: string;
|
|
1818
|
+
/** The state of the long-lived connection right now. Always `stopped` for webhook platforms */
|
|
1819
|
+
runtimeStatus: ChannelWithSecretResponseBodyRuntimeStatus;
|
|
1820
|
+
senderPolicy: ChannelWithSecretResponseBodySenderPolicy;
|
|
1821
|
+
status: ChannelWithSecretResponseBodyStatus;
|
|
1822
|
+
updatedAt: string;
|
|
1823
|
+
/** The webhook path, for gateway configuration and for diagnosis */
|
|
1824
|
+
webhookPath: string;
|
|
1825
|
+
/**
|
|
1826
|
+
* The webhook secret we generated, to paste into that platform's console. **It cannot be retrieved again** — the only way forward is rotating to a new one. Null when the platform generates the secret (secretSource=supplied) or does not use webhooks at all
|
|
1827
|
+
* @nullable
|
|
1828
|
+
*/
|
|
1829
|
+
webhookSecret: string | null;
|
|
1830
|
+
/**
|
|
1831
|
+
* The webhook address to paste into that platform's console. Null when the deployment declares no public entry point
|
|
1832
|
+
* @nullable
|
|
1833
|
+
*/
|
|
1834
|
+
webhookUrl: string | null;
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* Replaced wholesale rather than merged key by key. Absent means unchanged
|
|
1838
|
+
*/
|
|
1839
|
+
export type UpdateChannelRequestBodyCredentials = {
|
|
1840
|
+
[key: string]: string;
|
|
1841
|
+
};
|
|
1842
|
+
/**
|
|
1843
|
+
* Only when this is sent is allowFrom replaced along with it
|
|
1844
|
+
*/
|
|
1845
|
+
export type UpdateChannelRequestBodySenderPolicy = (typeof UpdateChannelRequestBodySenderPolicy)[keyof typeof UpdateChannelRequestBodySenderPolicy];
|
|
1846
|
+
export declare const UpdateChannelRequestBodySenderPolicy: {
|
|
1847
|
+
readonly bound_only: "bound_only";
|
|
1848
|
+
readonly open: "open";
|
|
1849
|
+
};
|
|
1850
|
+
export interface UpdateChannelRequestBody {
|
|
1851
|
+
/**
|
|
1852
|
+
* The allow list. Only applied when senderPolicy is sent as well
|
|
1853
|
+
* @nullable
|
|
1854
|
+
*/
|
|
1855
|
+
allowFrom?: string[] | null;
|
|
1856
|
+
/** Replaced wholesale rather than merged key by key. Absent means unchanged */
|
|
1857
|
+
credentials?: UpdateChannelRequestBodyCredentials;
|
|
1858
|
+
enabled?: boolean;
|
|
1859
|
+
/** @maxLength 128 */
|
|
1860
|
+
name?: string;
|
|
1861
|
+
/** Only when this is sent is allowFrom replaced along with it */
|
|
1862
|
+
senderPolicy?: UpdateChannelRequestBodySenderPolicy;
|
|
1863
|
+
}
|
|
1864
|
+
export interface BindingCodeResponseBody {
|
|
1865
|
+
code: string;
|
|
1866
|
+
expiresAt: string;
|
|
1867
|
+
}
|
|
1868
|
+
export interface RejectionResource {
|
|
1869
|
+
at: string;
|
|
1870
|
+
peerId: string;
|
|
1871
|
+
peerName: string;
|
|
1872
|
+
peerUsername: string;
|
|
1873
|
+
platform: string;
|
|
1874
|
+
textLength: number;
|
|
1875
|
+
verdict: string;
|
|
1876
|
+
}
|
|
1877
|
+
export interface RejectionListResponseBody {
|
|
1878
|
+
/** @nullable */
|
|
1879
|
+
rejections: RejectionResource[] | null;
|
|
1880
|
+
}
|
|
1881
|
+
export interface RotateSecretRequestBody {
|
|
1882
|
+
/** Required for platforms that generate the secret themselves (secretSource=supplied). Must be absent for `generated` ones */
|
|
1883
|
+
webhookSecret?: string;
|
|
1884
|
+
}
|
|
1885
|
+
export interface WebhookSecretResponseBody {
|
|
1886
|
+
webhookSecret: string;
|
|
1887
|
+
}
|
|
1888
|
+
export type SenderCheckResourceVerdict = (typeof SenderCheckResourceVerdict)[keyof typeof SenderCheckResourceVerdict];
|
|
1889
|
+
export declare const SenderCheckResourceVerdict: {
|
|
1890
|
+
readonly ALLOWED_BY_BINDING: "ALLOWED_BY_BINDING";
|
|
1891
|
+
readonly ALLOWED_BY_ALLOW_FROM: "ALLOWED_BY_ALLOW_FROM";
|
|
1892
|
+
readonly ALLOWED_BY_POLICY: "ALLOWED_BY_POLICY";
|
|
1893
|
+
readonly REJECTED_NOT_ALLOWED: "REJECTED_NOT_ALLOWED";
|
|
1894
|
+
};
|
|
1895
|
+
export interface SenderCheckResource {
|
|
1896
|
+
/** @nullable */
|
|
1897
|
+
allowFrom: string[] | null;
|
|
1898
|
+
allowed: boolean;
|
|
1899
|
+
/** @nullable */
|
|
1900
|
+
bindingId: string | null;
|
|
1901
|
+
senderPolicy: string;
|
|
1902
|
+
verdict: SenderCheckResourceVerdict;
|
|
1903
|
+
}
|
|
1904
|
+
export type LoginResourceStatus = (typeof LoginResourceStatus)[keyof typeof LoginResourceStatus];
|
|
1905
|
+
export declare const LoginResourceStatus: {
|
|
1906
|
+
readonly wait: "wait";
|
|
1907
|
+
readonly scanned: "scanned";
|
|
1908
|
+
readonly confirmed: "confirmed";
|
|
1909
|
+
readonly expired: "expired";
|
|
1910
|
+
readonly error: "error";
|
|
1911
|
+
readonly need_verify_code: "need_verify_code";
|
|
1912
|
+
};
|
|
1913
|
+
export interface LoginResource {
|
|
1914
|
+
/** When this login flow expires. Past that, stop polling and start a new one */
|
|
1915
|
+
expiresAt: string;
|
|
1916
|
+
id: string;
|
|
1917
|
+
/** The text to encode and render as a QR code by the client — not an image address and not a data URI. When a code expires this flow issues another and keeps waiting, so each poll may return a new string */
|
|
1918
|
+
qrcodeData: string;
|
|
1919
|
+
/** Why it failed. Present only when status is error or expired */
|
|
1920
|
+
reason: string;
|
|
1921
|
+
status: LoginResourceStatus;
|
|
1922
|
+
}
|
|
1923
|
+
export interface CredentialFieldResource {
|
|
1924
|
+
help: string;
|
|
1925
|
+
key: string;
|
|
1926
|
+
label: string;
|
|
1927
|
+
required: boolean;
|
|
1928
|
+
secret: boolean;
|
|
962
1929
|
}
|
|
963
|
-
export
|
|
964
|
-
|
|
1930
|
+
export type PlatformResourceSecretSource = (typeof PlatformResourceSecretSource)[keyof typeof PlatformResourceSecretSource];
|
|
1931
|
+
export declare const PlatformResourceSecretSource: {
|
|
1932
|
+
readonly generated: "generated";
|
|
1933
|
+
readonly supplied: "supplied";
|
|
1934
|
+
readonly none: "none";
|
|
1935
|
+
};
|
|
1936
|
+
export type PlatformResourceSetupChallenge = (typeof PlatformResourceSetupChallenge)[keyof typeof PlatformResourceSetupChallenge];
|
|
1937
|
+
export declare const PlatformResourceSetupChallenge: {
|
|
1938
|
+
readonly none: "none";
|
|
1939
|
+
readonly webhook: "webhook";
|
|
1940
|
+
readonly scan: "scan";
|
|
1941
|
+
};
|
|
1942
|
+
export type PlatformResourceSetupMethod = (typeof PlatformResourceSetupMethod)[keyof typeof PlatformResourceSetupMethod];
|
|
1943
|
+
export declare const PlatformResourceSetupMethod: {
|
|
1944
|
+
readonly credentials: "credentials";
|
|
1945
|
+
readonly scan: "scan";
|
|
1946
|
+
};
|
|
1947
|
+
export interface PlatformResource {
|
|
965
1948
|
/** @nullable */
|
|
966
|
-
|
|
967
|
-
}
|
|
968
|
-
/**
|
|
969
|
-
* The MCP and Anthropic spelling of `parameters`. Give one or the other, not both.
|
|
970
|
-
* @nullable
|
|
971
|
-
*/
|
|
972
|
-
export type ClientFunctionRequestInputSchema = {
|
|
973
|
-
[key: string]: unknown;
|
|
974
|
-
} | null;
|
|
975
|
-
/**
|
|
976
|
-
* JSON Schema for the arguments. Omit for an action that takes none.
|
|
977
|
-
* @nullable
|
|
978
|
-
*/
|
|
979
|
-
export type ClientFunctionRequestParameters = {
|
|
980
|
-
[key: string]: unknown;
|
|
981
|
-
} | null;
|
|
982
|
-
/**
|
|
983
|
-
* The function object from the OpenAI tools format.
|
|
984
|
-
*/
|
|
985
|
-
export interface ClientFunctionRequest {
|
|
986
|
-
/**
|
|
987
|
-
* What the action does, written for the model. An action without one can only be guessed at from its name. The 1024 ceiling is OpenAI's own limit on `tools[].function.description`, not a number chosen here: over it the upstream call fails with `string_above_max_length`, and refusing at submission is the clearer of the two places to refuse. It was 500, which ran out at about six enumerated entries — an action that must list what it accepts had nowhere to put the list.
|
|
988
|
-
* @minLength 1
|
|
989
|
-
* @maxLength 1024
|
|
990
|
-
*/
|
|
991
|
-
description: string;
|
|
992
|
-
/**
|
|
993
|
-
* The MCP and Anthropic spelling of `parameters`. Give one or the other, not both.
|
|
994
|
-
* @nullable
|
|
995
|
-
*/
|
|
996
|
-
inputSchema?: ClientFunctionRequestInputSchema;
|
|
997
|
-
/**
|
|
998
|
-
* @minLength 1
|
|
999
|
-
* @maxLength 64
|
|
1000
|
-
*/
|
|
1949
|
+
credentialFields: CredentialFieldResource[] | null;
|
|
1001
1950
|
name: string;
|
|
1951
|
+
resident: boolean;
|
|
1952
|
+
secretSource: PlatformResourceSecretSource;
|
|
1953
|
+
setupChallenge: PlatformResourceSetupChallenge;
|
|
1954
|
+
setupMethod: PlatformResourceSetupMethod;
|
|
1955
|
+
/** The webhook path template; {channel} is replaced with the channel id */
|
|
1956
|
+
webhookPath: string;
|
|
1002
1957
|
/**
|
|
1003
|
-
*
|
|
1958
|
+
* The full webhook address template. Null when the deployment declares no public entry point
|
|
1004
1959
|
* @nullable
|
|
1005
1960
|
*/
|
|
1006
|
-
|
|
1961
|
+
webhookUrlTemplate: string | null;
|
|
1007
1962
|
}
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
export type ClientActionRequestType = (typeof ClientActionRequestType)[keyof typeof ClientActionRequestType];
|
|
1012
|
-
export declare const ClientActionRequestType: {
|
|
1013
|
-
readonly function: "function";
|
|
1014
|
-
};
|
|
1015
|
-
/**
|
|
1016
|
-
* The shape of a tool in the OpenAI Chat Completions API, plus `readOnly` and `timeoutMs`.
|
|
1017
|
-
*/
|
|
1018
|
-
export interface ClientActionRequest {
|
|
1019
|
-
function: ClientFunctionRequest;
|
|
1020
|
-
/** True when the action changes nothing outside the client. Anything else goes through this conversation's approval before it runs. */
|
|
1021
|
-
readOnly: boolean;
|
|
1022
|
-
/**
|
|
1023
|
-
* How long the assistant should wait for this action. Omit for the default; longer values are capped.
|
|
1024
|
-
* @minimum 0
|
|
1025
|
-
*/
|
|
1026
|
-
timeoutMs?: number;
|
|
1027
|
-
/** Only functions are supported. */
|
|
1028
|
-
type?: ClientActionRequestType;
|
|
1963
|
+
export interface PlatformListResponseBody {
|
|
1964
|
+
/** @nullable */
|
|
1965
|
+
platforms: PlatformResource[] | null;
|
|
1029
1966
|
}
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
*
|
|
1034
|
-
* Send `actions` only when they differ from the last message on this conversation. Sending the
|
|
1035
|
-
* block without `actions` keeps whatever was declared before.
|
|
1036
|
-
*/
|
|
1037
|
-
export interface ClientContextRequest {
|
|
1038
|
-
/**
|
|
1039
|
-
* The actions on offer right now.
|
|
1040
|
-
*
|
|
1041
|
-
* Omit it when nothing changed since the last message. Send `[]` to say there is nothing
|
|
1042
|
-
* on offer — those are different: a client that moves off the page it was attached to has
|
|
1043
|
-
* to be able to say so, or the assistant keeps calling actions that no longer make sense.
|
|
1044
|
-
* @maxItems 32
|
|
1045
|
-
* @nullable
|
|
1046
|
-
*/
|
|
1047
|
-
actions?: ClientActionRequest[] | null;
|
|
1048
|
-
/**
|
|
1049
|
-
* Identifies this client while it stays open. Any stable string; one per tab or process.
|
|
1050
|
-
* @minLength 1
|
|
1051
|
-
* @maxLength 128
|
|
1052
|
-
*/
|
|
1053
|
-
clientId: string;
|
|
1054
|
-
/**
|
|
1055
|
-
* How the client calls itself, for example "Leaflow console (web)".
|
|
1056
|
-
* @maxLength 64
|
|
1057
|
-
*/
|
|
1058
|
-
label?: string;
|
|
1967
|
+
export interface VerifyCodeRequestBody {
|
|
1968
|
+
/** @minLength 1 */
|
|
1969
|
+
code: string;
|
|
1059
1970
|
}
|
|
1060
1971
|
/**
|
|
1061
|
-
*
|
|
1062
|
-
* @nullable
|
|
1063
|
-
*/
|
|
1064
|
-
export type MessagePartData = {
|
|
1065
|
-
[key: string]: unknown;
|
|
1066
|
-
} | null;
|
|
1067
|
-
/**
|
|
1068
|
-
* One piece of a message. `type` says which of the fields below carries it:
|
|
1069
|
-
*
|
|
1070
|
-
* - `text` — the words, in `text`
|
|
1071
|
-
* - `file` — an attachment uploaded earlier, by id in `attachmentId`
|
|
1072
|
-
* - `data-<something>` — context from the client, in `data`. The name after `data-` is yours;
|
|
1073
|
-
* it is shown to the assistant so it can tell one kind of block from another.
|
|
1074
|
-
*
|
|
1075
|
-
* Order matters: an attachment belongs where it was written, not at the end.
|
|
1972
|
+
* Error
|
|
1076
1973
|
*/
|
|
1077
|
-
export
|
|
1974
|
+
export type ErrorResponse = Error;
|
|
1975
|
+
export type ListThreadItemsParams = {
|
|
1078
1976
|
/**
|
|
1079
|
-
*
|
|
1080
|
-
* @
|
|
1977
|
+
* Return the window ending just above this ordinal.
|
|
1978
|
+
* @minimum 0
|
|
1081
1979
|
*/
|
|
1082
|
-
|
|
1980
|
+
before?: number;
|
|
1083
1981
|
/**
|
|
1084
|
-
*
|
|
1085
|
-
* @
|
|
1982
|
+
* Return the window starting just below this ordinal.
|
|
1983
|
+
* @minimum 0
|
|
1086
1984
|
*/
|
|
1087
|
-
|
|
1985
|
+
after?: number;
|
|
1088
1986
|
/**
|
|
1089
|
-
*
|
|
1090
|
-
* @
|
|
1987
|
+
* Return a window containing this ordinal. Only one of before, after and around may be given.
|
|
1988
|
+
* @minimum 0
|
|
1091
1989
|
*/
|
|
1092
|
-
|
|
1990
|
+
around?: number;
|
|
1093
1991
|
/**
|
|
1094
|
-
*
|
|
1095
|
-
* @
|
|
1992
|
+
* How many turns a window holds at most.
|
|
1993
|
+
* @minimum 1
|
|
1994
|
+
* @maximum 50
|
|
1096
1995
|
*/
|
|
1097
|
-
|
|
1098
|
-
}
|
|
1099
|
-
export
|
|
1100
|
-
client?: ClientContextRequest;
|
|
1996
|
+
turns?: number;
|
|
1997
|
+
};
|
|
1998
|
+
export type ListThreadTurnsParams = {
|
|
1101
1999
|
/**
|
|
1102
|
-
* The message, in the order it was written. A message with nothing but text is a single
|
|
1103
|
-
* text part; that is the ordinary case and nothing else is required.
|
|
1104
2000
|
* @minItems 1
|
|
2001
|
+
* @maxItems 200
|
|
1105
2002
|
*/
|
|
1106
|
-
|
|
1107
|
-
}
|
|
1108
|
-
export interface MemoryResource {
|
|
1109
|
-
/** The fact itself */
|
|
1110
|
-
body: string;
|
|
1111
|
-
createdAt: string;
|
|
1112
|
-
id: string;
|
|
1113
|
-
/** The name the assistant gave this fact; it overwrites or deletes its own entries by that name */
|
|
1114
|
-
name: string;
|
|
1115
|
-
/** Which conversation the assistant learned it in. That conversation may since have been deleted */
|
|
1116
|
-
sourceThreadId?: string;
|
|
1117
|
-
updatedAt: string;
|
|
1118
|
-
}
|
|
1119
|
-
export interface MemoryListResponseBody {
|
|
1120
|
-
items: MemoryResource[];
|
|
1121
|
-
}
|
|
1122
|
-
export interface DynamicCallResultRequestBody {
|
|
2003
|
+
ids?: string[];
|
|
1123
2004
|
/**
|
|
1124
|
-
* The
|
|
2005
|
+
* The next_cursor returned by the previous page. Omit it for the first page.
|
|
1125
2006
|
* @minLength 1
|
|
2007
|
+
* @maxLength 1024
|
|
1126
2008
|
*/
|
|
1127
|
-
|
|
1128
|
-
/**
|
|
1129
|
-
* Why it failed, when `ok` is false. It reaches the assistant, so write it for a reader who cannot see the screen.
|
|
1130
|
-
* @maxLength 2000
|
|
1131
|
-
*/
|
|
1132
|
-
error?: string;
|
|
2009
|
+
cursor?: string;
|
|
1133
2010
|
/**
|
|
1134
|
-
*
|
|
1135
|
-
* @
|
|
2011
|
+
* Items returned in this page. Defaults to 50; at most 200.
|
|
2012
|
+
* @minimum 1
|
|
2013
|
+
* @maximum 200
|
|
1136
2014
|
*/
|
|
1137
|
-
|
|
1138
|
-
ok: boolean;
|
|
1139
|
-
/** What the action produced. At most 64 KiB; use `nextCursor` for anything larger. */
|
|
1140
|
-
output?: string;
|
|
1141
|
-
}
|
|
1142
|
-
export interface TurnIDResponseBody {
|
|
1143
|
-
/** True when the assistant was already busy and this message was put in line instead of starting a turn. It is read at the next step of the turn already running, so there is nothing further to do — and turnId is empty in this case. */
|
|
1144
|
-
queued: boolean;
|
|
1145
|
-
/** How many messages were already waiting ahead of this one. Only meaningful when queued is true. */
|
|
1146
|
-
queuedAhead?: number;
|
|
1147
|
-
/** The turn this message started. Empty when the message was queued instead. */
|
|
1148
|
-
turnId: string;
|
|
1149
|
-
}
|
|
1150
|
-
/**
|
|
1151
|
-
* A map from question id to the answer chosen
|
|
1152
|
-
*/
|
|
1153
|
-
export type AnswerRequestBodyAnswers = {
|
|
1154
|
-
[key: string]: string;
|
|
2015
|
+
limit?: number;
|
|
1155
2016
|
};
|
|
1156
|
-
export
|
|
1157
|
-
/** A map from question id to the answer chosen */
|
|
1158
|
-
answers: AnswerRequestBodyAnswers;
|
|
1159
|
-
}
|
|
1160
|
-
export interface RevertRequestBody {
|
|
1161
|
-
/** The starting ordinal; that entry and everything after it is reverted */
|
|
1162
|
-
ordinal: number;
|
|
1163
|
-
}
|
|
1164
|
-
export interface RevertedCountResponseBody {
|
|
1165
|
-
reverted: number;
|
|
1166
|
-
}
|
|
1167
|
-
export interface FolderResource {
|
|
1168
|
-
createdAt: string;
|
|
1169
|
-
id: string;
|
|
1170
|
-
name: string;
|
|
1171
|
-
/** How many conversations are filed here and would show up in the default list. Archived and deleted ones are not counted, so this is exactly what `GET /api/v1/threads?folder=<id>` returns. */
|
|
1172
|
-
threadCount: number;
|
|
1173
|
-
updatedAt: string;
|
|
1174
|
-
}
|
|
1175
|
-
export interface FolderListResponseBody {
|
|
1176
|
-
/** @nullable */
|
|
1177
|
-
folders: FolderResource[] | null;
|
|
1178
|
-
}
|
|
1179
|
-
export interface CreateFolderRequestBody {
|
|
2017
|
+
export type ListTaskRunsParams = {
|
|
1180
2018
|
/**
|
|
2019
|
+
* The next_cursor returned by the previous page. Omit it for the first page.
|
|
1181
2020
|
* @minLength 1
|
|
1182
|
-
* @maxLength
|
|
2021
|
+
* @maxLength 1024
|
|
1183
2022
|
*/
|
|
1184
|
-
|
|
1185
|
-
}
|
|
1186
|
-
export interface UpdateFolderRequestBody {
|
|
2023
|
+
cursor?: string;
|
|
1187
2024
|
/**
|
|
1188
|
-
*
|
|
1189
|
-
* @
|
|
2025
|
+
* Items returned in this page. Defaults to 50; at most 200.
|
|
2026
|
+
* @minimum 1
|
|
2027
|
+
* @maximum 200
|
|
1190
2028
|
*/
|
|
1191
|
-
|
|
1192
|
-
}
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
/** @minimum 1 */
|
|
1200
|
-
page_size: number;
|
|
1201
|
-
/** @minimum 0 */
|
|
1202
|
-
total_count?: number;
|
|
1203
|
-
}
|
|
1204
|
-
/**
|
|
1205
|
-
* Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
|
|
1206
|
-
*/
|
|
1207
|
-
export interface CursorPagination {
|
|
1208
|
-
/** @minimum 1 */
|
|
1209
|
-
page_size: number;
|
|
1210
|
-
/** @nullable */
|
|
1211
|
-
next_cursor?: string | null;
|
|
1212
|
-
}
|
|
2029
|
+
limit?: number;
|
|
2030
|
+
};
|
|
2031
|
+
export type OpenRealtimeParams = {
|
|
2032
|
+
/**
|
|
2033
|
+
* @maxLength 4096
|
|
2034
|
+
*/
|
|
2035
|
+
ticket: string;
|
|
2036
|
+
};
|
|
1213
2037
|
export type UploadAttachmentParams = {
|
|
1214
2038
|
/**
|
|
1215
2039
|
* The name to show and to give the assistant. Images do not need one; anything else does, because the name is most of what says what the file is. Falls back to a generated name.
|
|
@@ -1217,6 +2041,15 @@ export type UploadAttachmentParams = {
|
|
|
1217
2041
|
*/
|
|
1218
2042
|
filename?: string;
|
|
1219
2043
|
};
|
|
2044
|
+
export type PutUploadPartParams = {
|
|
2045
|
+
policyId: string;
|
|
2046
|
+
};
|
|
2047
|
+
export type PutUploadPartHeaders = {
|
|
2048
|
+
/**
|
|
2049
|
+
* @minimum 1
|
|
2050
|
+
*/
|
|
2051
|
+
"X-Part-Size": number;
|
|
2052
|
+
};
|
|
1220
2053
|
export type ListBindingsParams = {
|
|
1221
2054
|
/**
|
|
1222
2055
|
* Items returned in this page. Defaults to 50; at most 200.
|
|
@@ -1273,38 +2106,3 @@ export type CheckSenderParams = {
|
|
|
1273
2106
|
*/
|
|
1274
2107
|
username?: string;
|
|
1275
2108
|
};
|
|
1276
|
-
export type ListThreadsParams = {
|
|
1277
|
-
/**
|
|
1278
|
-
* Search titles, case-insensitively. Empty returns the most recent conversations
|
|
1279
|
-
* @maxLength 100
|
|
1280
|
-
*/
|
|
1281
|
-
q?: string;
|
|
1282
|
-
/**
|
|
1283
|
-
* When true, returns **only** archived conversations; otherwise only unarchived ones
|
|
1284
|
-
*/
|
|
1285
|
-
archived?: boolean;
|
|
1286
|
-
/**
|
|
1287
|
-
* A folder id, or empty for the conversations in no folder
|
|
1288
|
-
* @maxLength 64
|
|
1289
|
-
*/
|
|
1290
|
-
folder?: string;
|
|
1291
|
-
/**
|
|
1292
|
-
* The next_cursor returned by the previous page. Omit it for the first page.
|
|
1293
|
-
* @minLength 1
|
|
1294
|
-
* @maxLength 1024
|
|
1295
|
-
*/
|
|
1296
|
-
cursor?: string;
|
|
1297
|
-
/**
|
|
1298
|
-
* Items returned in this page. Defaults to 50; at most 200.
|
|
1299
|
-
* @minimum 1
|
|
1300
|
-
* @maximum 200
|
|
1301
|
-
*/
|
|
1302
|
-
limit?: number;
|
|
1303
|
-
};
|
|
1304
|
-
export type ListEarlierItemsParams = {
|
|
1305
|
-
/**
|
|
1306
|
-
* From the document's earlier.before; returns entries before this ordinal
|
|
1307
|
-
* @minimum 0
|
|
1308
|
-
*/
|
|
1309
|
-
before: number;
|
|
1310
|
-
};
|