Requests API
The following reference information is intended for developers only. It uses technical language and assumes basic familiarity with HTML and HTTP concepts. If you are a normal user of VOW, you can safely skip this page.
The requests API offers two endpoints for putting work requests into VOW. The two endpoints both allow for the addition of new requests in VOW, but they are intended for different use cases. Both endpoints accept either multipart form data (FormData from JS, or the body of an HTML <form>), or JSON in an equivalent structure.
Authorisation
All endpoints for the requests API require a form of authorisation. This is done using a requests API key. All requests to VOW must include the API key, in one of the following ways:
- As a query parameter
token. e.g./api/work-request?token=example-api-key-here - As a bearer token in the
Authorizationheader. e.g. with a headerAuthorization: Bearer example-api-key-here
The requests API key can be generated and/or found under the System tab in the VOW settings.
Captcha
In addition to the requests API key, the request body must contain a Google ReCAPTCHA token, created with the VOW site key. This captcha token must be put in the g-recaptcha-response field of the body. For sites posting forms, the Google captcha script will do this automatically when included inside the body of an HTML <form> tag.
POST /api/work-request
Body params
unit_numberstring
The unit number of the property the request relates to.
house_numberstring
The house number of the property the request relates to.
street_namestring
The street name of the property the request relates to.
suburbstring
The suburb of the property the request relates to.
postcodestring
The postcode of the property the request relates to.
statestring
The state of the property the request relates to. Must be one of the following: 'nsw', 'qld', 'tas', 'sa', 'wa', 'nt', 'vic' or 'act'
first_namestringrequired
The given name of the requesting individual or the name of the requesting party.
last_namestring
The surname of the requesting individual. Should be blank for business entities.
phonestringrequired
The primary phone number for contact of the requestor. Either this, or the email_address field MUST be provided.
email_addressstringrequired
The email address for contact of the requestor. This field must be a valid email address. Either this, or the phone field MUST be provided.
invoice_addressstring
The full address string to send the invoice to.
invoice_namestring
The name of the invoicee
referralstring
The method of referral for the work request. Ideally should match the values in the Client referral types list in VOW.
work_typestring
The type of work being requested. MUST be one of 'quote' or 'valuation'
report_typestring
The type of report that must be produced as a result of the work. Should match the values in the Report types list in VOW.
report_purposestring
The purpose for the valuation. Should match the values in the Valuation purposes list in VOW.
instructionsstring
Additional instructions for the work.
Responses
200
OK. Returned when the request is successfully created. Returns JSON containing the ref of the created work request.
Response schemaobject 
400
Bad Request. Returned when the provided data to the endpoint differs from the specification outlined above.
429
Rate limit exceeded. Returned when too many requests are made in a short time. Make sure your use of the API is not excessive and try again later. If you absolutely need this limit increased, you can contact us.
500
Internal server error. Returned when something goes wrong with the server.
POST /api/work-request/unstructured
Unlike the structured endpoint above that takes a specific format to create work requests, the unstructured endpoint is designed to take unstructured or semi-structured data relating to a job, and produce a work request with some or all of the fields set.
As a result, the unstructured endpoint is more relaxed in what it accepts. There is only one specified field, which is optional. If this field is not provided and the request is multipart form data or a JSON body, then the request will be treated as a semi-structured JSON input.
This endpoint is primarily intended to function as a quick-start for users to adapt any existing forms to enter data into VOW, without needing to change existing websites to suit the format required by the structured endpoint.
Body params
textstring
If this field is the only field set in the body/form data, its content is treated as unstructured text data. The LLM will process it assuming it is human written text asking for work.
Responses
200
OK. Returned when the request is successfully created. Returns JSON containing the ref of the created work request.
Response schemaobject
400
Bad Request. Returned when no fields are provided on the request body, or the LLM is unable to extract information about a work request from the provided data.
429
Rate limit exceeded. Returned when too many requests are made in a short time. Make sure your use of the API is not excessive and try again later. If you absolutely need this limit increased, you can contact us.
500
Internal server error. Returned when something goes wrong with the server. Can also be returned if VOW is unable to access OpenAI.