Skip to content
Kindgi

Dismiss a queued run

View as Markdown
POST
/v1/projects/{projectId}/expert-queue/{runId}/dismiss
curl --request POST \
  --url https://example.com/v1/projects/example/expert-queue/example/dismiss \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Not worth correcting: it leaves the open queue, with who dismissed it and why. reopen undoes it. Needs write on the project, as correcting the run does.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

ProjectId — opaque branded string.

runId
required
string

Request Body

Section titled “Request Body”
Media typeapplication/json
object
reason
string
<= 500 characters
Examplegenerated
{
  "reason": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The item, dismissed.

Media typeapplication/json

A queued run: never its content, only what it was and where it stands.

object
runId
required
string
projectId
required
string
agentId
string
agentVersion
string
flowId
required
string
runStatus
required

How a run ended.

string
Allowed values: completed failed cancelled
completedAt
required
string format: date-time
rules
required

The rules that queued it, each at the version that did.

Array<object>
object
ruleId
required
string
version
required
integer
>= 1
wantedGroupIds
required

The corrector groups its rules want.

Array<string>
anyCorrection
required

One of its rules wants any correction.

boolean
progress
required

The live corrections on the run so far, by group.

object
total
required
integer
byGroup
required
Array<object>
object
correctorGroupId
required

null: unclassified.

string | null
count
required
integer
addedAt
required
string format: date-time
state
required

Where a queued run stands. corrected: every rule that queued it has the correction it wants. erased: the run’s content is gone (erased, or the run purged); the item shows nothing of it.

string
Allowed values: open corrected dismissed erased
closedAt
string format: date-time
closedBy

Who dismissed or reopened it last.

string
reason

Why it was dismissed, when they said.

string
can
required

What the caller may do with the item, by the check the routes make (write on the project, as correcting the run needs).

object
dismiss
required
boolean
reopen
required
boolean
Example
{
  "runStatus": "completed",
  "state": "open"
}

400

Section titled “400”

Malformed request body.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

The run isn’t in the project’s queue (expert-queue-item-not-found).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

409

Section titled “409”

The item isn’t open (expert-queue-item-not-open).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

413

Section titled “413”

The request body is over the API’s limit (request-too-large; details.maxBytes says how much).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

500

Section titled “500”

Server error (unmapped domain code or framework crash).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also