Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateAct

Creates a new AI task (act) within a session that can interact with tools and perform specific actions.

Request Syntax


PUT /workflow-definitions/workflowDefinitionName/workflow-runs/workflowRunId/sessions/sessionId/acts HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "task": "string",
   "toolSpecs": [ 
      { 
         "description": "string",
         "inputSchema": { ... },
         "name": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

sessionId

The unique identifier of the session to create the act in.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

workflowDefinitionName

The name of the workflow definition containing the session.

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z0-9_-]{1,40}

Required: Yes

workflowRunId

The unique identifier of the workflow run containing the session.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

task

The task description that defines what the act should accomplish.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10000.

Required: Yes

toolSpecs

A list of tool specifications that the act can invoke to complete its task.

Type: Array of ToolSpec objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "actId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

actId

The unique identifier for the created act.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

status

The initial status of the act after creation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permissions to perform this action.

message: You don't have sufficient permissions to perform this action. Verify your IAM permissions and try again.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

message: The requested operation conflicts with the current state of the resource.
resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Please try again later.

message: The service encountered an internal error. Try again later.
reason: The reason for the internal server error.
retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

message: The specified resource was not found.
resourceId: The identifier of the resource that wasn't found.
resourceType: The type of resource that wasn't found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would exceed a service quota limit.

message: The request would exceed one or more service quotas for your account.
quotaCode: The code for the specific quota that was exceeded.
resourceId: The identifier of the resource that exceeded the quota.
resourceType: The type of resource that exceeded the quota.
serviceCode: The service code for the quota that was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to too many requests. Please try again later.

message: The request was denied due to request throttling.
quotaCode: The quota code related to the throttling.
retryAfterSeconds: The number of seconds to wait before retrying the throttled request.
serviceCode: The service code where throttling occurred.

HTTP Status Code: 429

ValidationException

The input parameters for the request are invalid.

fieldList: The list of fields that failed validation.
message: The input fails to satisfy the constraints specified by the service.
reason: The reason for the validation failure.

HTTP Status Code: 400