Sensible Blog
API Reference
Try Sensible for free

List extractions

get
https://api.sensible.so/v0/extractions

Use this endpoint to get a filtered list of past extractions. This endpoint returns a summary for each extraction, listed in reverse chronological order. To get details about an extraction, use the Retrieve extraction by ID endpoint. This endpoint uses keyset pagination to retrieve the next page of results. By default it returns a first page of 20 extractions and an opaque continuation_token that you can pass in the next request to get the next page of results, until the endpoint returns continuation_token to indicate the last page. Use the limit parameter to configure page size.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
Defaults to 1970-01-01T00:00:00Z

Retrieves extractions with a created date that is equal to or later than this date-time. The default is the unix epoch.

date-time

Retrieves extractions with a created date that is equal to or earlier than this date-time. The default is the current date-time.

number
Defaults to 20

Use the limit to define the number of items you recieve on each page of the paginated response. The default is 20.

string

Get the next page of results by making a new request and passing the opaque continuation_token parameter that Sensible returns in the current page of responses. Sensible returns a null continuation_token in the response to indicate the last page.

string

Comma-delimited list of configurations by which to filter the retrieved extractions.

string

Comma-delimited list of document types by which to filter the retrieved extractions.

string

Comma-delimited list of environments (PRODUCTION, DEVELOPMENT) by which to filter the retrieved extractions.

string

Comma-delimited list of statuses (WAITING, PROCESSING, FAILED, COMPLETE) by which to filter the retrieved extractions.

number

Minimum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see Monitoring extraction metrics.

number

Maximum extraction coverage score by which to filter the retrieved extractions. For more information about scoring, see Monitoring extraction metrics.

string

Comma-delimited list of review statuses (APPROVED, NEEDS_REVIEW, REJECTED) by which to filter the retrieved extractions. For more information, see Human review. Sensible returns portfolio extractions if at least one document in the portfolio meets the specified status criteria.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 5 months ago