UNunified
genai
task

Update a task

Changed on

Updates the GenaiTask identified by id. Provide the unified GenaiTask fields to change in the request body.

put/genai/{connection_id}/task/{id}

Request

  • Base URL
    https://api.unified.to
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Task

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

A short human-readable title for the coding agent task.

instructionsstring

The natural-language instructions given to the coding agent.

status'PENDING' | 'RUNNING' | 'BLOCKED' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'EXPIRED' | 'OTHER'
model_idstring
user_idstring

(reference to HrisEmployee)

repo_urlstring

The git repository that the coding agent works in.

source_branch_identifierstring

The name of the branch that the coding agent starts its work from.

target_branch_identifierstring

The name of the branch that the coding agent pushed its work to.

pullrequest_urlstring

The pull/merge request that the coding agent opened for its work.

web_urlstring

The provider's own web page for this task.

summarystring

The coding agent's summary of the work that it performed.

errorstring

The failure description (when the status is FAILED).

files_changednumber
lines_addednumber
lines_deletednumber
tokens_usednumber
started_atstring date-time

When the coding agent started working on the task. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

When the coding agent stopped working on the task. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

agent_idstring

id of the genai_agent (the reusable agent/preset configuration) that runs this task.

organization_idstring

id of the genai_organization (the organization or execution environment) that this task runs under.

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

A short human-readable title for the coding agent task.

instructionsstring

The natural-language instructions given to the coding agent.

status'PENDING' | 'RUNNING' | 'BLOCKED' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'EXPIRED' | 'OTHER'
model_idstring
user_idstring

(reference to HrisEmployee)

repo_urlstring

The git repository that the coding agent works in.

source_branch_identifierstring

The name of the branch that the coding agent starts its work from.

target_branch_identifierstring

The name of the branch that the coding agent pushed its work to.

pullrequest_urlstring

The pull/merge request that the coding agent opened for its work.

web_urlstring

The provider's own web page for this task.

summarystring

The coding agent's summary of the work that it performed.

errorstring

The failure description (when the status is FAILED).

files_changednumber
lines_addednumber
lines_deletednumber
tokens_usednumber
started_atstring date-time

When the coding agent started working on the task. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

When the coding agent stopped working on the task. (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

agent_idstring

id of the genai_agent (the reusable agent/preset configuration) that runs this task.

organization_idstring

id of the genai_organization (the organization or execution environment) that this task runs under.

rawobject

Changes