APIHub
Back to Explore

Amazon Augmented AI Runtime

The Amazon Augmented AI Runtime API lets you manage human review loops for A2I flow definitions, including starting new loops, retrieving details of individual or multiple loops, stopping active loops, and deleting loops.

Cloud
apiKeyHeader
No HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

644ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
DELETE

/human-loops/{HumanLoopName}

Deletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException .

  • HumanLoopName (path, required) — The name of the human loop that you want to delete.
GET

/human-loops/{HumanLoopName}

Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.

  • HumanLoopName (path, required) — The name of the human loop that you want information about.
GET

/human-loops#FlowDefinitionArn

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

  • CreationTimeAfter (query) — (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24 .
  • CreationTimeBefore (query) — (Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24 .
  • FlowDefinitionArn (query, required) — The Amazon Resource Name (ARN) of a flow definition.
  • SortOrder (query) — Optional. The order for displaying results. Valid values: Ascending and Descending .
  • NextToken (query) — A token to display the next page of results.
  • MaxResults (query, limit) — The total number of items to return. If the total number of available items is more than the value specified in MaxResults , then a NextToken is returned in the output. You can use this token to display the next page of results.
POST

/human-loops

Starts a human loop, provided that at least one activation condition is met.

POST

/human-loops/stop

Stops the specified human loop.

5 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X DELETE \
  "https://github.com/mermade/aws2openapi/human-loops/{HumanLoopName}" \
  -H "Authorization: YOUR_API_KEY"

github.com · HTTPS only