curl --request POST \
--url https://api.watchdog.no/v1/documents/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>'})
};
fetch('https://api.watchdog.no/v1/documents/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/documents/search"
payload = { "query": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"mode": "ranked",
"passages": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"section_titles": [
"<string>"
],
"text": "<string>",
"score": 123
}
],
"unavailable_documents": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "indexing"
}
]
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Ranked search is temporarily unavailable, or a document could not be read for exact search. mode=exact with document_ids does not depend on ranked search.",
"request_id": "req_example"
}
}Search what the agreement text says about a subject
Finds what agreements say about a subject, such as price adjustment, notice periods or termination, in the contract text. mode=ranked (default) returns the most relevant passages by meaning and keywords from accepted agreement terms: documents attached to an agreement as its terms (the contract itself, not price lists) whose import into that agreement was accepted. Narrow it with agreement_ids or document_ids; documents in that selection that cannot be searched are listed in unavailable_documents. Ranked results show what a clause says, never that something is absent. mode=exact finds a literal string in the full extracted text of 1–10 document_ids of any kind; use it to quote a clause or to check that a phrase does not occur. Large documents may be read only in part: a partial result proves nothing about the unread text. To read a whole document, use GET /v1/documents//text.
curl --request POST \
--url https://api.watchdog.no/v1/documents/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>'})
};
fetch('https://api.watchdog.no/v1/documents/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/documents/search"
payload = { "query": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"mode": "ranked",
"passages": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"section_titles": [
"<string>"
],
"text": "<string>",
"score": 123
}
],
"unavailable_documents": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "indexing"
}
]
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Ranked search is temporarily unavailable, or a document could not be read for exact search. mode=exact with document_ids does not depend on ranked search.",
"request_id": "req_example"
}
}Authorizations
Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).
Headers
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Body
What to look for. ranked: a question or keywords, up to 4,000 characters. exact: the literal text, up to 256 characters; case and whitespace are ignored, punctuation is not.
1 - 4000ranked (default): the most relevant passages of accepted agreement terms, by meaning and keywords. exact: every occurrence of a literal string in the given document_ids.
ranked, exact ranked: search only these documents (at most 500); any that are not accepted agreement terms come back in unavailable_documents. exact: required, 1–10 documents of any kind in this organization.
1 - 500 elementsranked only: search the accepted terms of these agreements (at most 100). With document_ids too, a document must match both.
1 - 100 elementsranked: passages to return, 5 by default. exact: occurrences to collect per document, 20 by default; occurrences close together share one passage.
1 <= x <= 50