OpenAssistantAPI
→

User API

Tasks

Create, list, and manage tasks

GET/tasks

List tasks

Query parameters

pageinteger
perPageinteger
limitinteger
statusstring
typestring
minestring
searchstring
qstring
approvalGatestring
assistantstring

Responses

200Tasks
ok reqenumtrue
tasks reqobject[]
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring
pageinteger
perPageinteger
totalinteger

Request

curl 'https://app.openassistant.us/api/tasks' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "tasks": [
    {
      "id": "string",
      "status": "pending",
      "title": "string",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ]
}
POST/tasks

Create a task

Request body

title reqstring
assistant reqstring
descriptionstring
typestring
statusstring
skillsstring[]
assignedUsersstring[]
followersstring[]
onBehalfOfstring
modelTierenumlowmediumhighultra
onboardingboolean
generateTitleboolean
notificationScopeenumdefaultactivity_only
attachmentHintsobject[]
mimeTypestring

Responses

201Created
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "assistant": "string"
}'

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
GET/tasks/{taskId}

Get a task with activities and executions

Path parameters

taskId reqstring

Responses

200Task
ok reqenumtrue
task reqobject
idstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
statusenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
titlestring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAtstring
updatedAtstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z",
    "activities": [
      null
    ],
    "executions": [
      null
    ]
  }
}
PUT/tasks/{taskId}

Update a task

Path parameters

taskId reqstring

Request body

assistantstring
typestring
statusenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setscheduledcompleteddone_user_markederrorarchivedabandoneddeferred_accessfailed_access
ordernumber
titlestring
descriptionstring
summarystring
notesForNextRunstring | null
skillsstring[]
assignedUsersstring[]
followersstring[]
inputany
contextany
clarificationNeededboolean
errorstring | null
scheduledForstring | null
waitingOnContactsstring[]
approvalPickenuminheritautosemimanual
approvalOverrideobject | null
mode reqenuminheritautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
planany[]
planHistoryany[]
relatedFilesstring[]
planningModeboolean
hasWriteActionsboolean
modelTierenumlowmediumhighultra

Responses

200Updated
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>' \
  -X PUT \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "assistant": "string",
  "type": "string",
  "status": "pending",
  "order": 0
}'

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
DELETE/tasks/{taskId}

Delete a task

Path parameters

taskId reqstring

Responses

200Deleted
ok reqenumtrue
task reqobject
id reqstring
deletedboolean
messagestring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>' \
  -X DELETE \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "task": {
    "id": "string"
  }
}
PUT/tasks/{taskId}/assignees

Update task assignees

Path parameters

taskId reqstring

Request body

emails reqstring[]

Responses

200Updated
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/assignees' \
  -X PUT \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "emails": [
    "string"
  ]
}'

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
GET/tasks/collaborators

People this caller may collaborate with, before a task exists

The New Task composer needs the same `@` picker the task drawer has, at a moment when there is no task to gate on and nobody to exclude for already being seated. The co-worker filter is identical and still SERVER-SIDE.

Responses

200Collaborators
ok reqenumtrue
shareable reqobject[]
id reqstring
name reqstring
email reqstring
avatarUrlstring | null
assistantobject | null
id reqstring
namestring | null
avatarUrlstring | null

Request

curl 'https://app.openassistant.us/api/tasks/collaborators' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "shareable": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ]
}
GET/tasks/{taskId}/shareable

People this caller may share this task with

Co-worker filtered SERVER-SIDE. Never filter this on the client: whether an address belongs to an AGNT user outside your org is exactly what the collaboration privacy boundary exists to withhold, and this endpoint enumerates.

Path parameters

taskId reqstring

Responses

200Shareable users
ok reqboolean
shareable reqobject[]
id reqstring
name reqstring
email reqstring
avatarUrlstring | null
assistantobject | null
id reqstring
namestring | null
avatarUrlstring | null
invite reqobject
allowed reqboolean
teamId reqstring | null
reason reqstring | null

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/shareable' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "shareable": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ],
  "invite": {
    "allowed": true,
    "teamId": "string",
    "reason": "string"
  }
}
PUT/tasks/{taskId}/seats

Add or update one seat on a task

One seat per call. A seat carries read access to the task and its full history.

Path parameters

taskId reqstring

Request body

principalstring
principalEmailstring
accessenumviewcommentwork

Responses

200Updated
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/seats' \
  -X PUT \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "principal": "string",
  "principalEmail": "string",
  "access": "view"
}'

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
DELETE/tasks/{taskId}/seats/{principalId}

Remove a seat from a task

The owner may remove anyone; a seat may always remove itself.

Path parameters

taskId reqstring
principalId reqstring

Responses

200Updated
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/seats/<principalId>' \
  -X DELETE \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/{taskId}/typing

Tell the others in a shared task that you are writing

Published over the portal SSE channel to everyone else on the task and stored nowhere — a typing indicator is true for a few seconds and then it is a lie. Re-post while typing continues; the receiving client expires it on its own. Needs a comment seat or above, the same rung as speaking. A solo task reports 0 and does nothing.

Path parameters

taskId reqstring

Responses

200Published
success reqboolean
data reqobject
notified reqnumber

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/typing' \
  -X POST \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "success": true,
  "data": {
    "notified": 0
  }
}
GET/tasks/{taskId}/seat-invites

Seats YOU are holding on this task for people not yet on the team

Scoped to the caller. An invitation that goes nowhere should not become something your colleagues saw you do, so a pending seat is visible only to whoever held it. That is a query (`invitedBy: you`), not a field stripped on the way out — there is no shape of this response that can carry somebody else's pending invite.

Path parameters

taskId reqstring

Responses

200Held seats
ok reqenumtrue
seatInvites reqobject[]
id reqstring
task reqstring | null
invitation reqstring | null
email reqstring
invitedBy reqstring | null
createdAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/seat-invites' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "seatInvites": [
    {
      "id": "string",
      "task": "string",
      "invitation": "string",
      "email": "string",
      "invitedBy": "string",
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ]
}
DELETE/tasks/{taskId}/seat-invites/{inviteId}

Stop holding a seat

Drops the RESERVATION only. The team invitation it rides on is untouched and the person is still invited to the team — conflating the two would let "actually, not on this task" quietly cancel somebody's invitation to the company.

Path parameters

taskId reqstring
inviteId reqstring

Responses

200Released
ok reqenumtrue
seatInvite reqobject
id reqstring
task reqstring | null
invitation reqstring | null
email reqstring
invitedBy reqstring | null
createdAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/seat-invites/<inviteId>' \
  -X DELETE \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "seatInvite": {
    "id": "string",
    "task": "string",
    "invitation": "string",
    "email": "string",
    "invitedBy": "string",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/{taskId}/feedback

Submit task feedback

Path parameters

taskId reqstring

Request body

status reqenumlikedislikenull

Responses

200Feedback
ok reqenumtrue
feedback reqobject
success reqboolean
taskId reqstring
status reqstring | null
message reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/feedback' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "status": "like"
}'

Response

{
  "ok": true,
  "feedback": {
    "success": true,
    "taskId": "string",
    "status": "string",
    "message": "string"
  }
}
POST/tasks/{taskId}/stop

Stop task execution

Path parameters

taskId reqstring

Responses

200Stopped
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/stop' \
  -X POST \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/{taskId}/mark-done

Mark task as done by user (stops agent, sets done_user_marked status)

Path parameters

taskId reqstring

Responses

200Marked done
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/mark-done' \
  -X POST \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/{taskId}/mark-not-done

Reopen a completed/done_user_marked task and force-wake Prime with a reason (same mechanism as an alarm wake)

Path parameters

taskId reqstring

Responses

200Marked not done
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/mark-not-done' \
  -X POST \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/{taskId}/approve

Approve an agent-created task (flips approvalGate to approved and enqueues execution)

Path parameters

taskId reqstring

Request body

reasonstring

Responses

200Approved
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/approve' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/{taskId}/decline

Decline an agent-created task (flips approvalGate to declined; task never runs)

Path parameters

taskId reqstring

Request body

reasonstring

Responses

200Declined
ok reqenumtrue
task reqobject
id reqstring
ownerstring | null
assistantobject | null
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
accountobject | null
id reqstring
name reqstring
slug reqstring
logoUrlstring | null
assigneesstring[]
followersobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
onBehalfOfstring | null
onBehalfOfCommittedAtstring | null
waitingOnContactsobject[]
id reqstring
type reqenumuserassistantcontact
emailstring
firstNamestring | null
lastNamestring | null
avatarstring | null
environmentstring
typeenumtemplatetaskreminderrecipient
skillsstring[]
status reqenumpendingexecutingon_holdpausedawaiting_user_inputawaiting_non_user_responsealarm_setsubtasks_runningscheduledmessage_receivedconversationcompleteddone_user_markederrorarchivedabandonedhandled_by_otherdeferred_accessfailed_accesscredits_blocked
handledByobject | null
assistantId reqstring
assistantNamestring | null
decidingTaskIdstring | null
messageIdstring | null
rulestring | null
decidedAtstring | null
conversationalboolean
originobject | null
platform reqenumchatnewTaskUItask_activityemailslackteamssmswhatsappimessagephonediscordtelegramworkflow_spawnedunknownnull
ordernumber
title reqstring
descriptionstring | null
userDescriptionstring | null
descriptionAuthorenumuserassistant
statusMessagestring | null
summarystring | null
notesForNextRunstring | null
releasedRRobject[]
id reqstring
notestring
atstring
clarificationNeededany
errorstring | null
pauseReasonstring | null
parkOriginenumuserassistantnull
readyForReviewboolean
scheduledForstring | null
scheduledHeadlinestring | null
executedAtstring | null
completedAtstring | null
lastSeenAtstring | null
hasInboxItemboolean
hasWriteActionsboolean
templateTaskIdstring | null
workflowSkillIdstring | null
workflowSkillInstallIdstring | null
planany[]
executionPlanstring[]
planHistoryany[]
executionIdstring | null
pendingResumeobject | null
keystring
snapshotAtstring | null
parkedStatusstring
bytesnumber
subtasksany[]
followupsobject[]
id reqstring
scheduledForstring | null
status reqenumpendingcompletedcancelled
message reqstring
triggeredAtstring | null
metadataobject
createdAt reqstring
chatIdstring | null
relatedEventstring | null
relatedFilesstring[]
tagsstring[]
parentTaskIdstring | null
groupTaskIdstring | null
ownerProfileany
seatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
addedBystring | null
runTaskIdstring | null
projectSeatsobject[]
principalstring | null
principalEmailstring | null
principalNamestring | null
principalAvatarUrlstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
assistantstring | null
accessenumviewcommentworkdispatch
assignedboolean
followingboolean
runTaskIdstring | null
projectAssistantsobject[]
id reqstring
namestring | null
avatarUrlstring | null
projectOwnerProfileany
projectOwnerAssistantany
waitingOnobject[]
kind reqstring
principalstring | null
principalNamestring | null
assistantstring | null
assistantNamestring | null
assistantAvatarUrlstring | null
principalAvatarUrlstring | null
sincestring | null
seatPendingCartobject | null
cartId reqstring
statusstring | null
labelstring | null
projectTitlestring | null
seatForstring | null
recipientForstring | null
jsonModestring | null
jsonResultobject | null
pendingRecipientTaskIdsstring[]
delegatedByAssistantboolean
delegatedByPeerboolean
sharedThreadSideboolean
peerDelegatorTaskIdstring | null
peerDelegatedFromobject | null
assistantNamestring | null
assistantEmailstring | null
principalNamestring | null
principalEmailstring | null
lastAskedAtstring | null
peerWaitWokenAtstring | null
schedulingMeetingIdstring | null
requestingAssistantobject | null
namestring | null
firstNamestring | null
emailstring | null
avatarstring | null
principalNamestring | null
principalEmailstring | null
lastScramblerOutputobject | null
ranAtstring | null
meetingIdstring | null
hasCleanOverlapboolean
noMatchboolean
strategiesany[]
participantCountnumber
slotsComparednumber
permutationsTestednumber
visibilityenumnormalinternal
modelTierenumlowmediumhighultra
onboardingboolean
effortenumlowmediumhighxhighmax
createdByenumuseragent
approvalGateenumpending_user_approvalapproveddeclined
approvalGateParkedAtstring | null
approvalEventsobject[]
surfaceenumportalemail_linkpushsmsinbox
action reqenumapprovedecline
userIdstring | null
at reqstring
reasonstring | null
approvalOverrideobject | null
mode reqenumautotime-boxedmanualnull
timeBoxedWindowMinnumber | null
undoDelaySecnumber | null
setByenumuserassistantgatemanual_inheritnull
effectiveApprovalModeenumautotime-boxedmanualdeniednull
approvalPickenuminheritautosemimanual
approvalPickSourceenumsettingsuserassistantgatemanual_inheritunknown
approvalLabelenumautosemimanualcustom
approvalUnreadableboolean
approvalGateHoldsstring[]
approvalBaselineobject
kind reqenumpresetcustom
presetenumautosemimanual
reasons reqobject[]
resourcestring
idstring
scopestring
scopeIdstring
label reqstring
modestring
governsBaselineboolean
governsEffectiveboolean
audienceSizenumber
coveredRecipientsnumber[]
audiencesobject[]
size reqnumber
coveredRecipients reqnumber[]
effectiveApprovalModesobject
approvalLocksobject[]
resource reqstring
mode reqenumautotime-boxedmanualdenied
scope reqenumorgteamaccount
spawnedBySubtaskIdstring | null
alarmobject | null
wakeAt reqstring
reason reqstring
headlinestring | null
notestring | null
visibleboolean
status reqenumsetfiredcancelled
setAtstring
followupCountnumber
kindenumusersubtask_fallbacknull
sourceenumprimeautonull
waitingForobject[]
whatstring
expectedBystring
doormanSnoozesnumber
overdueboolean
crossChatDuplicateAwarenessobject | null
siblingTaskId reqstring
contactstring | null
detectedAtstring | null
acknowledgedAtstring | null
coverageTransferobject[]
span reqstring
direction reqenumto_backupto_primary
action reqenumactivateendseizerevert
fromOwnerstring | null
toOwnerstring | null
seizedBystring | null
primaryStaysFollowerboolean
handedAt reqstring
threadCursorsobject[]
threadKey reqstring
lastSeenAt reqstring
lastSeenActivityIdstring | null
runStateobject | null
skillsLoadedstring[]
toolGroupsLoadedstring[]
atomsExercisedstring[]
channelsTouchedstring[]
narrowingProfileenumwidenarrow
lastModelCallAtstring | null
lastModelCallProviderstring | null
approvalNoteSeenAtstring | null
updatedAtstring | null
pendingCartobject | null
status reqenumopensubmittedpending_approvaltime_boxedapprovedexecutingexecutedcancelledrejectedfailed
label reqstring
timeBoxedExpiresAtstring | null
timeBoxedWindowMinnumber | null
timeBoxedExpiryenumexecutecancelnull
originChatIdstring | null
dispatches reqobject[]
type reqstring
description reqstring
platform reqstring
to reqstring[]
subjectstring
bodystring
verbatimboolean
status reqstring
cartHistoryobject[]
labelstring
resolvedApprovalModeenumautotime-boxedmanualnull
timeBoxedExpiresAtstring | null
timeBoxedExpiryenumexecutecancelnull
dispatchesobject[]
typestring
descriptionstring
platformstring
tostring[]
ccstring[]
bccstring[]
subjectstring
bodystring
statusstring
errorstring
resolution reqenumauto_sentmanually_approvedauto_sent_expirymanually_deniedauto_cancelled_expiryfailed
triggerstring | null
outcomeSummaryobject
submittedAtstring | null
resolvedAtstring
usageobject
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheCreationTokensnumber
costUsdnumber
runsnumber
turnsnumber
panicRecoveryAttemptsnumber
executingStuckRetriesnumber
subtaskSurfaceRetriesnumber
subtaskStallNotifiedboolean
reapCountnumber
loopBreakerobject | null
signaturestring | null
repeatCountnumber
parkedAtstring | null
creditUsageobject | null
consumednumber
cycleConsumednumber
softNotifiedAtCreditsnumber
softNotifiedAtstring | null
grantedCeilingnumber
parkedAtstring | null
lastPauseNotifiedAtstring | null
overBudgetAskDeliveredAtstring | null
landingWrapUpIssuedAtstring | null
zeroBalanceLandingOverrideCountnumber
checkpointModeenumperiodicunlimited
checkpointIntervalUsdnumber | null
lifetimeGrantedCeilingnumber
pauseFactsShownstring[]
noProgressBreakerobject | null
parkedAtstring | null
chatReverifyBreakerobject | null
chatIdstring | null
cycleCountnumber
lastMessageTaskAtstring | null
trippedAtstring | null
abuseFlagobject | null
flaggedboolean
flaggedAtstring | null
reasonstring | null
notifiedAtstring | null
recoveryHintobject | null
reasonstring | null
toolstring | null
atstring | null
speedbumpsobject
createdAt reqstring
updatedAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/decline' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

Response

{
  "ok": true,
  "task": {
    "id": "string",
    "status": "pending",
    "title": "string",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  }
}
POST/tasks/approve-batch

Approve multiple agent-created tasks in one request

Request body

taskIds reqstring[]

Responses

200Batch result
ok reqenumtrue
batch reqobject
approved reqstring[]
failed reqobject[]
taskId reqstring
error reqstring

Request

curl 'https://app.openassistant.us/api/tasks/approve-batch' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "taskIds": [
    "string"
  ]
}'

Response

{
  "ok": true,
  "batch": {
    "approved": [
      "string"
    ],
    "failed": [
      {
        "taskId": "string",
        "error": "string"
      }
    ]
  }
}
POST/tasks/{taskId}/process

Process task (trigger AI)

Path parameters

taskId reqstring

Request body

messagestring
filesany[]

Responses

200Processing
ok reqenumtrue
process reqobject
success reqboolean
taskId reqstring
executionIdstring
messagestring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/process' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string",
  "files": [
    null
  ]
}'

Response

{
  "ok": true,
  "process": {
    "success": true,
    "taskId": "string"
  }
}
POST/tasks/{taskId}/seen

Mark task as seen (updates lastSeenAt, clears unread)

Path parameters

taskId reqstring

Request body

lastSeenAtstring

Responses

200Updated
ok reqenumtrue
lastSeen reqobject
lastSeenAt reqstring

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/seen' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "lastSeenAt": "string"
}'

Response

{
  "ok": true,
  "lastSeen": {
    "lastSeenAt": "2025-01-15T10:30:00.000Z"
  }
}
GET/tasks/{taskId}/usage

Per-run usage breakdown for a task (Trace rollup grouped by run + model)

Path parameters

taskId reqstring

Responses

200Usage rollup
total reqobject
inputTokens reqnumber
outputTokens reqnumber
cacheReadTokens reqnumber
cacheCreationTokens reqnumber
totalTokens reqnumber
costUsd reqnumber
runs reqinteger
turns reqinteger
rows reqobject[]
runId reqstring | null
runType reqstring | null
runLabel reqstring | null
seq reqinteger
model reqstring | null
provider reqstring | null
inputTokens reqnumber
outputTokens reqnumber
cacheReadTokens reqnumber
cacheCreationTokens reqnumber
totalTokens reqnumber
costUsd reqnumber
turns reqinteger
startedAt reqstring | null
modelTierstring | null
northStarProductnumber
creditsobject
total reqnumber
costsByType reqobject
runs reqobject[]
runKind reqstring | null
multiplier reqnumber
chargedCredits reqnumber
hardCogsUsd reqnumber
isBillable reqboolean
createdAt reqstring
costsByType reqany...
runShapeobject
runs reqnumber
turnsPerRun reqnumber
toolCallsPerTurn reqnumber
toolCallSum reqnumber
toolTurnCount reqnumber
subtaskSpawnsByProfile reqobject
research reqnumber
worker reqnumber
custom reqnumber
tierMix reqobject
low reqnumber
medium reqnumber
high reqnumber
continueCount reqnumber
subtaskDepth reqnumber
researchNoteCount reqnumber
researchNoteChars reqnumber
releasedBigResults reqnumber
unreleasedBigResults reqnumber
autoManagedBigResultsnumber
releaseRationumber | null
status reqstring | null
wallClockMs reqnumber | null
costUsd reqnumber
northStarProductnumber

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/usage' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "total": {
    "inputTokens": 0,
    "outputTokens": 0,
    "cacheReadTokens": 0,
    "cacheCreationTokens": 0,
    "totalTokens": 0,
    "costUsd": 0
  },
  "rows": [
    {
      "runId": "string",
      "runType": "string",
      "runLabel": "string",
      "seq": 0,
      "model": "string",
      "provider": "string"
    }
  ]
}
GET/tasks/{taskId}/scheduling-snapshot

Aggregated scheduling state for the live Scheduling Engine UI (organizer sees full data; non-organizers see redacted participant rows)

Path parameters

taskId reqstring

Responses

200Snapshot
ok reqenumtrue
snapshot reqobject
parentTaskId reqstring
meetingId reqstring | null
meetingWindow reqobject | null
startsAt reqstring
endsAt reqstring
viewerIsOrganizer reqboolean
totalRecipients reqnumber
submittedCount reqnumber
pendingCount reqnumber
failedCount reqnumber
participants reqobject[]
recipientTaskId reqstring
email reqstring | null
profileany
taskStatus reqstring
status reqenumpendingsubmittedavailableno_slotsdegradedfailed
submittedAt reqstring | null
jsonResult reqobject | null
redactedboolean
lastScramblerOutput reqobject | null
ranAt reqstring
meetingId reqstring
hasCleanOverlap reqboolean
noMatch reqboolean
strategies reqobject[]
id reqstring
friction reqenumnonelowmediumhigh
type reqenumclean_overlapsingle_yieldmulti_yield
slot reqany...
moves reqany[]
affectedParticipants reqstring[]
unconfirmedParticipants reqstring[]
requiresPermission reqboolean
summary reqstring
participantCount reqnumber
slotsCompared reqnumber
permutationsTested reqnumber

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/scheduling-snapshot' \
  -H "Authorization: Bearer ak_live_..."

Response

{
  "ok": true,
  "snapshot": {
    "parentTaskId": "string",
    "meetingId": "string",
    "meetingWindow": {
      "startsAt": "2025-01-15T10:30:00.000Z",
      "endsAt": "2025-01-15T10:30:00.000Z"
    },
    "viewerIsOrganizer": true,
    "totalRecipients": 0,
    "submittedCount": 0
  }
}
POST/tasks/{taskId}/scheduling-preview

Live SlotSolver preview with currently-submitted recipient data (organizer only)

Path parameters

taskId reqstring

Request body

excludeEmailsstring[]

Responses

200Preview
ok reqenumtrue
preview reqobject
meetingId reqstring
ranAt reqstring
hasCleanOverlap reqboolean
noMatch reqboolean
strategies reqobject[]
id reqstring
friction reqenumnonelowmediumhigh
type reqenumclean_overlapsingle_yieldmulti_yield
slot reqobject
startsAt reqstring
endsAt reqstring
duration reqnumber
moves reqany[]
affectedParticipants reqstring[]
unconfirmedParticipants reqstring[]
requiresPermission reqboolean
summary reqstring
participantCount reqnumber
slotsCompared reqnumber
permutationsTested reqnumber
includedParticipants reqstring[]
missingParticipants reqstring[]
excludedParticipants reqstring[]
partial reqboolean

Request

curl 'https://app.openassistant.us/api/tasks/<taskId>/scheduling-preview' \
  -X POST \
  -H "Authorization: Bearer ak_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "excludeEmails": [
    "string"
  ]
}'

Response

{
  "ok": true,
  "preview": {
    "meetingId": "string",
    "ranAt": "2025-01-15T10:30:00.000Z",
    "hasCleanOverlap": true,
    "noMatch": true,
    "strategies": [
      {
        "id": "string",
        "friction": "none",
        "type": "clean_overlap",
        "slot": {
          "startsAt": null,
          "endsAt": null,
          "duration": null
        },
        "moves": [
          null
        ],
        "affectedParticipants": [
          null
        ]
      }
    ],
    "participantCount": 0
  }
}