API Documentation

Use the Sigmie API to index documents and seamlessly integrate Sigmie into your application.

The Sigmie API is built on REST principles. It uses resource-oriented URLs for predictability, accepts JSON-encoded request bodies, returns JSON-encoded responses, and employs standard HTTP response codes, authentication, and verbs.

Each Sigmie application is hosted on a unique server, resulting in distinct base URLs for each.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Filtering

Understand how to write filters.

Read more

Errors

Read about the different types of errors.

Read more

Sorting

Learn how to sort the matched hits.

Read more