メインコンテンツへスキップ
POST
/
api
/
publicapi
/
v1
/
transactions
/
launch
新しいトランザクションでファイル処理を開始します
curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'Files=<string>' \
  --form 'Model={
  "files": [
    {
      "imageProcessingOptions": {},
      "index": "<string>",
      "registrationParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "registrationParameters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "skillParameters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}' \
  --form Files.items='@example-file'
import requests

url = "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch"

files = { "Files.items": ("example-file", open("example-file", "rb")) }
payload = {
    "Files": "<string>",
    "Model": "{
  \"files\": [
    {
      \"imageProcessingOptions\": {},
      \"index\": \"<string>\",
      \"registrationParameters\": [
        {
          \"key\": \"<string>\",
          \"value\": \"<string>\"
        }
      ]
    }
  ],
  \"registrationParameters\": [
    {
      \"key\": \"<string>\",
      \"value\": \"<string>\"
    }
  ],
  \"skillParameters\": [
    {
      \"key\": \"<string>\",
      \"value\": \"<string>\"
    }
  ]
}"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('Files', '<string>');
form.append('Model', '{
  "files": [
    {
      "imageProcessingOptions": {},
      "index": "<string>",
      "registrationParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "registrationParameters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "skillParameters": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}');
form.append('Files.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch', 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://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model\"\r\n\r\n{\r\n  \"files\": [\r\n    {\r\n      \"imageProcessingOptions\": {},\r\n      \"index\": \"<string>\",\r\n      \"registrationParameters\": [\r\n        {\r\n          \"key\": \"<string>\",\r\n          \"value\": \"<string>\"\r\n        }\r\n      ]\r\n    }\r\n  ],\r\n  \"registrationParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ],\r\n  \"skillParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model\"\r\n\r\n{\r\n  \"files\": [\r\n    {\r\n      \"imageProcessingOptions\": {},\r\n      \"index\": \"<string>\",\r\n      \"registrationParameters\": [\r\n        {\r\n          \"key\": \"<string>\",\r\n          \"value\": \"<string>\"\r\n        }\r\n      ]\r\n    }\r\n  ],\r\n  \"registrationParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ],\r\n  \"skillParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model\"\r\n\r\n{\r\n  \"files\": [\r\n    {\r\n      \"imageProcessingOptions\": {},\r\n      \"index\": \"<string>\",\r\n      \"registrationParameters\": [\r\n        {\r\n          \"key\": \"<string>\",\r\n          \"value\": \"<string>\"\r\n        }\r\n      ]\r\n    }\r\n  ],\r\n  \"registrationParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ],\r\n  \"skillParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model\"\r\n\r\n{\r\n  \"files\": [\r\n    {\r\n      \"imageProcessingOptions\": {},\r\n      \"index\": \"<string>\",\r\n      \"registrationParameters\": [\r\n        {\r\n          \"key\": \"<string>\",\r\n          \"value\": \"<string>\"\r\n        }\r\n      ]\r\n    }\r\n  ],\r\n  \"registrationParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ],\r\n  \"skillParameters\": [\r\n    {\r\n      \"key\": \"<string>\",\r\n      \"value\": \"<string>\"\r\n    }\r\n  ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
  "detail": "<string>",
  "instance": "<string>",
  "status": "<string>",
  "title": "<string>",
  "type": "<string>"
}
{
  "detail": "<string>",
  "instance": "<string>",
  "status": "<string>",
  "title": "<string>",
  "type": "<string>"
}

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

skillId
string

ボディ

multipart/form-data
Files
file[]

multipart/* コンテンツとして送信されたファイルを取得するためのモデル

Model
object

トランザクション処理の追加 Parameter です。TransactionLaunchMetadataDto モデルを参照してください。

レスポンス

トランザクションの作成と開始が正常に完了しました

transactionId
string<uuid>
必須