Update Agent Execution
curl --request PATCH \
--url https://api.example.com/api/v1/agent-executions/{agent_execution_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"state": {
"dataExtracted": {},
"status": "PENDING_REVIEW"
}
}
'import requests
url = "https://api.example.com/api/v1/agent-executions/{agent_execution_id}"
payload = { "state": {
"dataExtracted": {},
"status": "PENDING_REVIEW"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({state: {dataExtracted: {}, status: 'PENDING_REVIEW'}})
};
fetch('https://api.example.com/api/v1/agent-executions/{agent_execution_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/agent-executions/{agent_execution_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'state' => [
'dataExtracted' => [
],
'status' => 'PENDING_REVIEW'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/agent-executions/{agent_execution_id}"
payload := strings.NewReader("{\n \"state\": {\n \"dataExtracted\": {},\n \"status\": \"PENDING_REVIEW\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/agent-executions/{agent_execution_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"state\": {\n \"dataExtracted\": {},\n \"status\": \"PENDING_REVIEW\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agent-executions/{agent_execution_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"state\": {\n \"dataExtracted\": {},\n \"status\": \"PENDING_REVIEW\"\n }\n}"
response = http.request(request)
puts response.read_body{
"agentId": "<string>",
"workspaceId": "<string>",
"state": {
"status": "PENDING_INPUTS"
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Agent Executions
Update Agent Execution
PATCH
/
api
/
v1
/
agent-executions
/
{agent_execution_id}
Update Agent Execution
curl --request PATCH \
--url https://api.example.com/api/v1/agent-executions/{agent_execution_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"state": {
"dataExtracted": {},
"status": "PENDING_REVIEW"
}
}
'import requests
url = "https://api.example.com/api/v1/agent-executions/{agent_execution_id}"
payload = { "state": {
"dataExtracted": {},
"status": "PENDING_REVIEW"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({state: {dataExtracted: {}, status: 'PENDING_REVIEW'}})
};
fetch('https://api.example.com/api/v1/agent-executions/{agent_execution_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/agent-executions/{agent_execution_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'state' => [
'dataExtracted' => [
],
'status' => 'PENDING_REVIEW'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/agent-executions/{agent_execution_id}"
payload := strings.NewReader("{\n \"state\": {\n \"dataExtracted\": {},\n \"status\": \"PENDING_REVIEW\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/agent-executions/{agent_execution_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"state\": {\n \"dataExtracted\": {},\n \"status\": \"PENDING_REVIEW\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agent-executions/{agent_execution_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"state\": {\n \"dataExtracted\": {},\n \"status\": \"PENDING_REVIEW\"\n }\n}"
response = http.request(request)
puts response.read_body{
"agentId": "<string>",
"workspaceId": "<string>",
"state": {
"status": "PENDING_INPUTS"
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
BearerBasic
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
- AgentExecutionPendingReview
- AgentExecutionCancel
- AgentExecutionConfirm
- AgentExecutionStateDeliveredToDestination
Show child attributes
Show child attributes
Response
Successful Response
- AgentExecutionStatePendingInputs
- AgentExecutionStatePendingDataExtraction
- AgentExecutionStatePendingReview
- AgentExecutionStateCanceled
- AgentExecutionStateConfirmed
- AgentExecutionStateDeliveredToDestination
Show child attributes
Show child attributes
Was this page helpful?
⌘I