Skip to navigation

Search prompts

Returns extractor prompts. Excludes deleted prompts unless includeDeleted is true.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
document_classstringOptional>=1 character
include_deletedbooleanOptionalDefaults to false
order_byenumOptionalDefaults to name
Allowed values:
order_direnumOptionalDefaults to asc
Allowed values:
pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional1-100Defaults to 50
qstringOptional>=1 character

Case-insensitive fuzzy search on prompt name

Response

Prompts page
has_moreboolean
itemslist of objects
pageinteger
page_sizeinteger

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error