タスク開始または停止

curl --request POST \
  --url https://api.example.com/api/agentTools/startOrStopTask

const options = {method: 'POST'};

fetch('https://api.example.com/api/agentTools/startOrStopTask', 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/agentTools/startOrStopTask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/agentTools/startOrStopTask"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agentTools/startOrStopTask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

POST

api

agentTools

startOrStopTask

タスク開始または停止

curl --request POST \
  --url https://api.example.com/api/agentTools/startOrStopTask

const options = {method: 'POST'};

fetch('https://api.example.com/api/agentTools/startOrStopTask', 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/agentTools/startOrStopTask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/agentTools/startOrStopTask"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agentTools/startOrStopTask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

リクエストボディ、生成されたcURL例、レスポンススキーマはAPIパネルに表示されます。

AgentTools経由で既存のOctoparseタスクを開始または停止します。

タスクを特定する

タスクIDが不明な場合はsearchTasksを使用します。

アクションを指定する

actionにはstartまたはstopを送信します。

エクスポートへ進む

レスポンスのガイダンスでデータが利用可能になったことが示されたら、exportDataを使用します。

searchTasks -> startOrStopTask -> exportData

リクエストボディ

taskIdとactionは必須です。

アクション

actionの値はstartまたはstopです。

ステータス値

start_requestedとstop_requestedはリクエストが受け付けられたことを示します。already_runningとalready_stoppedは状態変更が不要だったことを示します。start_rejected、stop_rejected、invalidは、クライアント側の処理またはユーザー確認が必要です。

レスポンスのガイダンス

固定のポーリング間隔ではなく、retryGuidance、suggestedNextCall、workflow、toolHintに従ってください。