Skip to content
Task Groups

PATCHhttps://core-api.heysadie.ai/taskgroups/{id}/tasks/{taskId}

id taskId order name description instructions outputs toolNames type success data tenantId taskgroupId isDeleted createdAt updatedAt deletedAt metadata timestamp version path error code message details field

Update task

Try it in the API Explorer

Example request

Terminal
curl -X PATCH "https://core-api.heysadie.ai/taskgroups/TASKGROUP_ID/tasks/TASK_ID" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order": 0,
    "name": "string",
    "description": "string"
  }'

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

taskIdstringrequired

UUID of the task.

Body application/json · required

ordernumberoptional
namestringoptional
descriptionstringoptional
instructionsstringoptional
outputsstring[] | nulloptional
toolNamesstring[] | nulloptional
typestring | nulloptional

Responses

200
successbooleanrequired
dataobjectoptional
Show 14 child properties
idstring (uuid)required
tenantIdstring (uuid)required
taskgroupIdstring (uuid)required
ordernumberrequired
namestringrequired
descriptionstringrequired
instructionsstringrequired
outputsstring[] | nullrequired
toolNamesstring[] | nullrequired
typestring | nullrequired
isDeletedbooleanrequired
createdAtstring (date-time) | string (date) | number | nullrequired
updatedAtstring (date-time) | string (date) | number | nullrequired
deletedAtstring (date-time) | string (date) | number | nullrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional