Read contract details from an attached document

POST

/api/v1/assistant/documents/{id}/terms

const url = 'http://127.0.0.1:8484/api/v1/assistant/documents/example/terms';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://127.0.0.1:8484/api/v1/assistant/documents/example/terms

The built-in assistant reads the document and proposes notice days, cancel link, start date, trial end and account. Nothing is saved: apply what you keep with update_subscription.

Parameters

Path Parameters

required

string

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

documentId

required

string

fields

required

Array<object> | null

object

current

What Exhale has now, if anything

string

field

required

The update_subscription field it fills

string

Allowed values: noticeDays cancelUrl startedOn trialEndsOn account

quote

The words of the document it is based on, as the model reported them

string

value

required

The checked value; noticeDays as a whole number

string

model

required

string

notes

required

Array<string> | null

subscriptionId

required

string

Example

{
  "$schema": "https://example.com/api/schemas/AssistantTerms.json",
  "fields": [
    {
      "field": "noticeDays"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}