Get Or Create SOV Output
curl --request POST \
--url https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"output_format": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overwrite_existing": false,
"revision": -1
}
'import requests
url = "https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output"
payload = {
"output_format": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overwrite_existing": False,
"revision": -1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
output_format: '<string>',
job_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
overwrite_existing: false,
revision: -1
})
};
fetch('https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output', 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.sovfixer.com/api/v1/sov/{id}/get_or_create_output",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'output_format' => '<string>',
'job_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'overwrite_existing' => false,
'revision' => -1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.sovfixer.com/api/v1/sov/{id}/get_or_create_output"
payload := strings.NewReader("{\n \"output_format\": \"<string>\",\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"overwrite_existing\": false,\n \"revision\": -1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"output_format\": \"<string>\",\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"overwrite_existing\": false,\n \"revision\": -1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"output_format\": \"<string>\",\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"overwrite_existing\": false,\n \"revision\": -1\n}"
response = http.request(request)
puts response.read_body{
"request": {
"id": "<string>",
"status": "PENDING"
},
"result": {
"label": "<string>",
"output_format": "<string>",
"scrubbed_filename": "<string>",
"url": "<string>"
}
}Get SOV Data
Get Or Create SOV Output
If an output file is already available, it will be returned. If not, a new output file will be generated and an id will be provided to check the status.
POST
/
api
/
v1
/
sov
/
{id}
/
get_or_create_output
Get Or Create SOV Output
curl --request POST \
--url https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"output_format": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overwrite_existing": false,
"revision": -1
}
'import requests
url = "https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output"
payload = {
"output_format": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overwrite_existing": False,
"revision": -1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
output_format: '<string>',
job_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
overwrite_existing: false,
revision: -1
})
};
fetch('https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output', 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.sovfixer.com/api/v1/sov/{id}/get_or_create_output",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'output_format' => '<string>',
'job_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'overwrite_existing' => false,
'revision' => -1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.sovfixer.com/api/v1/sov/{id}/get_or_create_output"
payload := strings.NewReader("{\n \"output_format\": \"<string>\",\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"overwrite_existing\": false,\n \"revision\": -1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"output_format\": \"<string>\",\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"overwrite_existing\": false,\n \"revision\": -1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sovfixer.com/api/v1/sov/{id}/get_or_create_output")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"output_format\": \"<string>\",\n \"job_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"overwrite_existing\": false,\n \"revision\": -1\n}"
response = http.request(request)
puts response.read_body{
"request": {
"id": "<string>",
"status": "PENDING"
},
"result": {
"label": "<string>",
"output_format": "<string>",
"scrubbed_filename": "<string>",
"url": "<string>"
}
}Authorizations
Token-based authentication with required prefix "Token"
Path Parameters
SOV ID or SUD ID.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
The desired output format.
Minimum string length:
1If provided, associate with this existing job instead of creating a new one.
If true, regenerate the output file even if it already exists.
The revision number of the SOV to use, -1 is the latest, 0 is the initial SOV (this field is ignored when a SUD ID is provided).
⌘I