Update a tool task status

URL Expired

The URL for this request expired after 30 days.

Parameters

discussionId

• Type: string
• Required: Yes
• The unique identifier of the discussion

toolTaskId

• Type: string
• Required: Yes
• The unique identifier of the tool task

state

• Type: string
• Enum:
• Required: Yes
• New state for the tool task
• Allowed:
  • submitted
  • working
  • input-required
  • completed
  • canceled
  • failed

message

• Type: string
• Optional: Status message

response

• Type: string
• Tool execution response (required when state is completed)

x-universe-auth

• Type: string
• Required: JWT authentication token

Responses

• 200 Tool task updated successfully
• 400 Bad request - validation failed or error updating tool task
• 401 Unauthorized - invalid or missing authentication
• 404 Discussion or tool task not found
• 500 Internal server error

Example CURL Request

curl --request PUT \
     --url https://example.com/chats/discussionId/tool-tasks/toolTaskId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "state": "submitted"\n}\n'  

Click Try It! to start a request and see the response here! Or choose an example:

Example Response

{
  "status": "200",
  "message": "Updated",
  "timestamp": "3 months ago"
}