Search

Search scoped libraries and assets for evidence

post/v1/search

Request body

querystring required
execution_policy'local_only' | 'prefer_local' | 'cloud_allowed' | 'cloud_required' required
limitinteger

Response

Search results

request_idstring required
warningsstring[] required

Changes

Changed in 3 of the 4 revisions of this API.143437

  • c15615d5499311711See the full diff
    • added the new required request property execution_policy

      new-required-request-property

    • added the new required request property scope

      new-required-request-property

    • removed subschema #1 subschema #2 from the request body anyOf list

      request-body-any-of-removed

    • removed the media type multipart/form-data from the request body

      request-body-media-type-removed

    • the request property query became required

      request-property-became-required

    • the query request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • removed the required property credits_remaining from the response with the 200 status

      response-required-property-removed

    • removed the required property credits_used from the response with the 200 status

      response-required-property-removed

    • removed the required property request_id from the response with the 200 status

      response-required-property-removed

    • removed the required property results from the response with the 200 status

      response-required-property-removed

    • the optional response header x-request-id removed for the status 200

      optional-response-header-removed

    • removed the request property filters

      request-property-removed

    • removed the request property image

      request-property-removed

    • removed the request property include_answer

      request-property-removed

    • removed the request property max_results

      request-property-removed

    • removed the request property ranking_mode

      request-property-removed

    • removed the optional property answer from the response with the 200 status

      response-optional-property-removed

    • api operation id search removed and replaced with searchEvidence

      api-operation-id-removed

    • added the new optional request property limit

      new-optional-request-property

    • the query request property's maxLength was increased from 400 to 1000

      request-property-max-length-increased

    • removed the pattern \S from the request property query

      request-property-pattern-removed

    • added ResponseMetadata subschema #2 to the response body allOf list for the response status 200

      response-body-all-of-added

    • removed the non-success response with the status 400

      response-non-success-status-removed

    • removed the non-success response with the status 401

      response-non-success-status-removed

    • removed the non-success response with the status 403

      response-non-success-status-removed

    • removed the non-success response with the status 422

      response-non-success-status-removed

    • removed the non-success response with the status 429

      response-non-success-status-removed

    • removed the non-success response with the status 500

      response-non-success-status-removed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6cccdc178a95520See the full diff
    • added the new internal_error enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 429

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 500

      response-property-enum-value-added

    • added the new optional request property image

      new-optional-request-property

    • added subschema #1 subschema #2 to the request body anyOf list

      request-body-any-of-added

    • added the media type multipart/form-data to the request body

      request-body-media-type-added

    • the request property query became optional

      request-property-became-optional

    • added the non-success response with the status 422

      response-non-success-status-added

    • added the optional property error/request_id to the response with the 400 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 401 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 403 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 429 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 500 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 400 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 401 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 403 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 429 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 500 status

      response-optional-property-added

    • removed the api_error enum value from the error/code response property for the response status 400

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 401

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 403

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 429

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 500

      response-property-enum-value-removed

  • 503281cd9fb33226See the full diff
    • removed subschema #1 subschema #2 from the request body anyOf list

      request-body-any-of-removed

    • removed the media type multipart/form-data from the request body

      request-body-media-type-removed

    • the request property query became required

      request-property-became-required

    • the optional response header x-request-id removed for the status 200

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 400

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 401

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 403

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 429

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 500

      optional-response-header-removed

    • removed the request property image

      request-property-removed

    • removed the optional property error/request_id from the response with the 400 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 401 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 403 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 429 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 500 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 400 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 401 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 403 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 429 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 500 status

      response-optional-property-removed

    • added the new api_error enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 429

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 500

      response-property-enum-value-added

    • removed the non-success response with the status 422

      response-non-success-status-removed

    • removed the internal_error enum value from the error/code response property for the response status 400

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 401

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 403

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 429

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 500

      response-property-enum-value-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog