> ## Documentation Index > Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt > Use this file to discover all available pages before exploring further. # 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/{id}/text. ## OpenAPI ````yaml /openapi-preview.json post /v1/documents/search openapi: 3.1.0 info: title: Watchdog API version: 1.0.0 description: >- The Watchdog API is served from https://api.watchdog.no. Request bodies are limited to 2 MiB unless an endpoint says otherwise. Files are uploaded directly to storage, not through the API. servers: - url: https://api.watchdog.no description: Watchdog API security: [] paths: /v1/documents/search: post: tags: - Documents summary: Search what the agreement text says about a subject description: >- 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/{id}/text. operationId: searchDocuments parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations. requestBody: required: true content: application/json: schema: type: object properties: mode: type: string enum: - ranked - exact default: ranked description: >- ranked (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. query: type: string minLength: 1 maxLength: 4000 description: >- 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. document_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 500 description: >- 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. agreement_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 100 description: >- ranked only: search the accepted terms of these agreements (at most 100). With document_ids too, a document must match both. limit: type: integer minimum: 1 maximum: 50 description: >- ranked: passages to return, 5 by default. exact: occurrences to collect per document, 20 by default; occurrences close together share one passage. required: - query additionalProperties: false responses: '200': description: Relevant passages and the documents that could not be searched. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: oneOf: - type: object properties: mode: type: string enum: - ranked passages: type: array items: type: object properties: document_id: type: string format: uuid document_name: type: string section_titles: type: array items: type: string text: type: string score: type: number required: - document_id - document_name - section_titles - text - score unavailable_documents: type: array items: type: object properties: document_id: type: string format: uuid status: type: string enum: - indexing - unavailable required: - document_id - status required: - mode - passages - unavailable_documents - type: object properties: mode: type: string enum: - exact documents: type: array items: type: object properties: status: type: string enum: - found - not_found_in_extracted_text - partial - unavailable description: >- found: at least one occurrence. not_found_in_extracted_text: the whole text was read without one. partial: only part of the text was read in time and nothing was found, which proves nothing about the rest. unavailable: the document has no text to search yet. matches_truncated: type: boolean description: >- True when the passages may not cover every occurrence: more than limit occurred, the scan stopped early, or an occurrence was too long to quote. passages: type: array items: type: string description: >- Text around the occurrences, in document order. Occurrences whose surrounding text overlaps share one passage; passages start and end at whole words. document_id: type: string format: uuid required: - status - matches_truncated - passages - document_id required: - mode - documents '400': description: >- The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: 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 '401': description: The bearer token is missing or invalid. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. WWW-Authenticate: schema: type: string required: false description: Bearer authentication challenge, when supplied. content: application/json: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: The bearer token is missing or invalid. request_id: req_example '403': description: >- Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required 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 '404': description: The resource does not exist in the current organization. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_not_found' example: error: code: not_found message: The resource does not exist in the current organization. request_id: req_example '429': description: Too many requests. Wait for the Retry-After delay before retrying. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- Too many requests. Wait for the Retry-After delay before retrying. request_id: req_example '500': description: >- Unexpected server failure. Include the request ID when contacting support. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_internal_error' example: error: code: internal_error message: >- Unexpected server failure. Include the request ID when contacting support. request_id: req_example '503': description: >- 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. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_service_unavailable' 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 security: - ApiKeyBearer: [] components: schemas: Error_validation_error: type: object properties: error: type: object properties: code: type: string enum: - validation_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_invalid_token: type: object properties: error: type: object properties: code: type: string enum: - invalid_token message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required: type: object properties: error: type: object properties: code: type: string enum: - forbidden - token_disabled - organization_required - insufficient_role - mfa_required message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_not_found: type: object properties: error: type: object properties: code: type: string enum: - not_found message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_rate_limit_exceeded: type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_internal_error: type: object properties: error: type: object properties: code: type: string enum: - internal_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_service_unavailable: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error securitySchemes: ApiKeyBearer: type: http scheme: bearer description: >- 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). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.