Hướng dẫn AgentFlow

list_instances

GET/instances

Authorization

AuthorizationBearer <token>

A service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.

In: header

Query Parameters

limit?integer

Page size.

Formatint32
Range1 <= value <= 200
cursor?string

Forward cursor (walks toward the next page).

before?string

Backward cursor (walks toward the previous page). Mutually exclusive with cursor.

sort?"started_at"

The sort field; started_at by default.

Value in

  • "started_at"
dir?string

The sort direction; desc by default.

Value in

  • "asc"
  • "desc"
q?string

A case-insensitive substring of the run's name, its id, or its workflow's name.

status?string

Value in

  • "running"
  • "paused"
  • "completed"
  • "failed"
  • "cancelled"
archived?boolean

When true, list only archived instances; absent / false lists only active ones.

is_simulation?boolean

When true, list only simulation (test-run) attempts; absent / false lists only production runs (the default excludes test runs).

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/instances"
{  "items": [    {      "active_task_count": 0,      "audit_event_count": 0,      "auth_blocked_at": "2019-08-24T14:15:22Z",      "auth_blocked_reason": null,      "completed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "definition_id": "91c1994f-b1db-4fef-840d-7d3ab2984871",      "foreach_progress": null,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "instance_token_budget_max": 0,      "is_draft_run": true,      "is_simulation": true,      "name": "string",      "outcome_label": "string",      "paused_at": "2019-08-24T14:15:22Z",      "paused_root_id": "0e6d3aaf-b535-42bc-a767-719ab64acb3e",      "sim_parent_attempt_id": "49ed1a39-53f7-477c-b4e6-83397a19c280",      "sim_source_node_id": "string",      "snapshot_hash": "string",      "started_at": "2019-08-24T14:15:22Z",      "started_by": "03987f6a-4c27-4dc1-b6ab-c7e83bb3e713",      "starter": null,      "status": "running",      "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",      "waiting_stage": null,      "workflow_name": "string"    }  ],  "next_cursor": "string",  "prev_cursor": "string"}