Parameters

This section describes the available parameters you can send to the LawyerGPT API endpoints, including how they influence behavior and output formatting. Parameters are designed to offer flexibility while maintaining strong defaults for rapid deployment.

Common Parameters (All Endpoints)

Parameter
Type
Required
Default
Description

api_key

string

✅ Yes

Your personal or organizational API key. This authenticates your requests.

language

string

❌ No

"en"

Language in which the response will be generated. Follows ISO 639-1 format (e.g., "en", "es", "pl").

tone

string

❌ No

"neutral"

Determines the formality of the response. Can be formal, neutral, or friendly.

jurisdiction

string

❌ No

Legal region or territory to tailor the output (e.g., "California, USA" or "EU").

context

string

❌ No

Optional extra legal context or background that helps the model generate better responses.

Parameters for /ask Endpoint

Parameter
Type
Required
Description

question

string

✅ Yes

Legal question to be answered by the GPT model.

case_type

string

❌ No

Optionally specify the legal area, like "civil", "criminal", "corporate", "intellectual property".

urgency

string

❌ No

low, medium, or high — may affect level of detail in response.

Parameters for /generate-document

Parameter
Type
Required
Description

document_type

string

✅ Yes

Type of document to be generated (e.g., nda, contract, employment_agreement).

parties

array

✅ Yes

Names or identifiers of involved entities.

custom_clauses

array

❌ No

Any user-specified clauses to include.

format

string

❌ No

Desired document format: text, markdown, or html.

length_limit

number

❌ No

Approximate length in characters or words (e.g., 3000).

Parameter
Type
Required
Description

input_text

string

✅ Yes

Full legal document or excerpt to summarize.

summary_type

string

❌ No

One of: bullet_points, paragraph, headline.

target_reader

string

❌ No

Audience profile: lawyer, client, regulator. Adjusts language complexity.

Internationalization Parameters

Parameter
Type
Description

language

string

Target output language (e.g., "en", "es", "de").

regional_format

string

Adjusts terminology to region (e.g., US, UK, EU).

Security & Compliance Parameters

Parameter
Type
Description

compliance_check

boolean

Run a compliance validation step before returning response.

redact_sensitive

boolean

Enable automatic redaction of names, addresses, etc.

Notes

  • Parameters are validated via strict schema parsing.

  • Any unrecognized parameters will return a 400 Bad Request error.

  • Future versions may deprecate or introduce new parameters.

Last updated