Tasks

Create a new task

post/api/tasks

Request body

taskstring required
agentIdstring
taskTypestring
tagsstring[]
priorityinteger
dependsOnstring[]
offeredTostring
dirstring
parentTaskIdstring
keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

source'mcp' | 'slack' | 'api' | 'ui' | 'github' | 'gitlab' | 'agentmail' | 'system' | 'schedule' | 'workflow' | 'linear' | 'jira'
outputSchemaobject
contextKeystring
requestedByUserIdstring
modelstring
modelTier'smol' | 'regular' | 'smart' | 'ultra'
effort'off' | 'low' | 'medium' | 'high' | 'xhigh' | 'max'
draftboolean

Response

Task created

idstring uuid required
keystring required

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

agentIdstring nullable required
creatorAgentIdstring
taskstring required
titlestring
status'draft' | 'backlog' | 'unassigned' | 'offered' | 'reviewing' | 'pending' | 'in_progress' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'superseded' required
source'mcp' | 'slack' | 'api' | 'ui' | 'github' | 'gitlab' | 'agentmail' | 'system' | 'schedule' | 'workflow' | 'linear' | 'jira'
taskTypestring
tagsstring[]
priorityinteger
dependsOnstring[]
offeredTostring
offeredAtstring date-time
acceptedAtstring date-time
rejectionReasonstring
createdAtstring date-time required
lastUpdatedAtstring date-time required
finishedAtstring date-time
notifiedAtstring date-time
failureReasonstring
outputstring
progressstring
slackChannelIdstring
slackThreadTsstring
slackTriggerMessageTsstring
slackUserIdstring
slackReplySentboolean
slackProgressMessageTsstring
slackTreeRootMessageTsstring
vcsProvider'github' | 'gitlab'
vcsRepostring
vcsEventTypestring
vcsNumberinteger
vcsCommentIdinteger
vcsAuthorstring
vcsUrlstring
vcsInstallationIdinteger
vcsNodeIdstring
agentmailInboxIdstring
agentmailMessageIdstring
agentmailThreadIdstring
mentionMessageIdstring
mentionChannelIdstring
dirstring
parentTaskIdstring
claudeSessionIdstring
modelstring
modelTier'smol' | 'regular' | 'smart' | 'ultra'
effort'off' | 'low' | 'medium' | 'high' | 'xhigh' | 'max'
scheduleIdstring
workflowRunIdstring uuid nullable
workflowRunStepIdstring uuid nullable
contextKeystring
outputSchemaobject
wasPausedboolean
compactionCountinteger
peakContextPercentnumber
peakContextTokensinteger
contextWindowSizeinteger
credentialKeySuffixstring
credentialKeyTypestring
requestedByUserIdstring
swarmVersionstring
provider'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'acp'
providerMetaobject
harnessVariantstring
harnessVariantMetaobject
totalCostUsdnumber
routingAffinityInvalidboolean

Changes

Changed in 8 of the 104 revisions of this API.167

    • added the new acp enum value to the response property for the response status

      response-property-enum-value-added

    • added the new acp enum value to the / response property for the response status

      response-property-enum-value-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

  • 6f2d2fbe259911See the full diff
    • added the new draft enum value to the response property for the response status

      response-property-enum-value-added

    • added the new optional request property

      new-optional-request-property

    • the request property's max was set to 100.00

      request-property-max-set

    • the request property's min was set to 0.00

      request-property-min-set

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the new optional request property

      new-optional-request-property

    • added the new max enum value to the request property

      request-property-enum-value-added

    • removed the enum value max of the request property

      request-property-enum-value-removed

    • removed the request property

      request-property-removed