Skip to content

report

POST
/public/agent-task/report
curl --request POST \
--url https://enclave.subnoto.com/public/agent-task/report \
--header 'Content-Type: application/json' \
--data '{ "taskUuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "summary": "example", "state": "working", "link": "https://example.com" }'

Report agent task progress. Reuse the same taskUuid across calls to build a single task’s history. Use state=‘working’ for in-progress updates and ‘complete’, ‘failure’, or ‘idle’ to signal an end state.

Media type application/json
object
taskUuid
required

Client-generated UUID that groups multiple reports into a single task. Reuse this UUID to append updates to the same task.

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
summary
required

One-line status description of what the agent is doing now (160 characters maximum, no newlines).

string
>= 1 characters <= 160 characters
state
required

Current task state. Use ‘working’ for in-progress, ‘complete’ when finished, ‘failure’ when you need user input or have hit a blocker, ‘idle’ when nothing is in progress.

string
Allowed values: working complete idle failure
link

Optional URL pointing to a relevant resource (PR, issue, artifact, log). Must be http(s).

string format: uri
<= 2048 characters

Default Response

Media type application/json
object
reportId
required

The numeric ID of the stored report row.

number
timestamp
required

The unix timestamp (ms) recorded on the report.

number
Example generated
{
"reportId": 1,
"timestamp": 1
}

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR TUNNEL_SESSION_NOT_FOUND INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example
{
"error": {
"code": "AUTHENTICATION_ERROR"
}
}

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example
{
"error": {
"code": "AUTHORIZATION_ERROR"
}
}

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example
{
"error": {
"code": "INTERNAL_SERVER_ERROR"
}
}