Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}
.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Query Parameters
The number of documents to skip before starting to collect the result set.
Required range:
x >= 0
Example:
0
The numbers of results to return.
Required range:
1 <= x <= 100
Example:
20
Body
application/json
Search parameters
Example:
["all-job-descriptions"]
A random string that uniquely identify the resource.
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Required range:
0 <= x <= 1
Available options:
None
, Low
, Mid
, Upper
Example:
"Low"
Required range:
0 <= x <= 1
Response
Will return matching documents
Total number of results
Required range:
x >= 0
Example:
130
URL to request next page of results
Example:
"https://api.affinda.com/v2/search?limit=20&offset=20"
URL to request previous page of results
Example:
"https://api.affinda.com/v2/search?limit=20"