Your First Request

Learn how to make your first document analysis request and explore the results.

Request Structure

BHB analysis is triggered by sending a POST request to our API endpoint. The request body must include the URL of the document you wish to analyze.

curl --request POST \
  --url 'https://server.proggor.com/' \
  --header 'Authorization: Bearer YOUR_JWT_TOKEN' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data url=https://en.wikipedia.org/wiki/MissingNo. \
  --data email=your@email.com \
  --data type=developer \
  --data ts=1692821028 \
  --data key=1000000030

Parameter Reference

Parameter	Type	Description
url	String	The public URL of the document to analyze.
email	String	Your official email associated with the credentials.
type	Enum	`user`, `business`, `academic`, `developer`

Interpreting the Response

The API returns a JSON object containing the full document split into sentences and a rich array of identified notes.

Payload Warning

For very large documents, the JSON response may exceed your browser's memory limits. It is advisable to use curl or a dedicated client for exploration.

Code Generation

Generate client SDKs in your preferred language by pasting our OpenAPI URL into the Swagger Editor.

← Authentication API Reference →