Skip to main content
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>",
  "revision": -1,
  "overwrite_existing": false
}
'
{
  "request": {
    "status": "PENDING",
    "id": "<string>"
  },
  "result": {
    "label": "<string>",
    "output_format": "<string>",
    "scrubbed_filename": "<string>",
    "url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
string
required

SOV ID or SUD ID.

Body

​
output_format
string
required

The desired output format.

Minimum string length: 1
​
revision
integer
default:-1

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).

​
overwrite_existing
boolean
default:false

If true, regenerate the output file even if it already exists.

Response

201 - application/json

SOV output response with request status and result if already available.

​
request
object
required

Information about the request status.

​
result
object

Result if the file is already available.