POST

/human-loops

http://a2i-runtime.sagemaker.{region}.amazonaws.com/human-loops

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

Access Token Required: API Key

Body Params

HumanLoopNamestringrequired

The name of the human loop.

DataAttributesobject

Attributes of the data specified by the customer. Use these to describe the data to be labeled.

HumanLoopInputobjectrequired

An object containing the human loop input in JSON format.

FlowDefinitionArnstringrequired

The Amazon Resource Name (ARN) of the flow definition associated with this human loop.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://a2i-runtime.sagemaker.{region}.amazonaws.com/human-loops' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}