Sign in
assistant

Retrieve

Retrieve relevant document chunks for a user message. Returns tool responses with context from documents without generating an answer.

post/api/assistant/retrieve

Headers

workspace-keystring

Request body

contentstring required
toolsobject
workspace_ext_idstring required
parent_message_ext_idstring nullable
config_ext_idstring nullable

Response

Successful Response

{"stackTrail":"paths:/api/assistant/retrieve:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 6 of the 34 revisions of this API.968

  • 1f956ac3d1c12See the full diff
    • ○

      added the new optional request property tools/additionalProperties/oneOf[subschema #2: RetrievalChunkTool]/tool_responses/additionalProperties/items/metadata/heading

      new-optional-request-property

    • ○

      added the new optional request property tools/additionalProperties/oneOf[subschema #3: RetrievalFullContextTool]/tool_responses/additionalProperties/items/metadata/heading

      new-optional-request-property

  • 849d5e8732f63See the full diff
    • ○

      added the new optional header request parameter workspace-key

      new-optional-request-parameter

    • ○

      added trace discriminator mapping keys to the tools/additionalProperties/ request property

      request-property-discriminator-mapping-added

    • ○

      added TraceTool to the tools/additionalProperties/ request property oneOf list

      request-property-one-of-added

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

  • 8d3e894e6c0b6See the full diff
    • ▲

      added the new required request property tools/additionalProperties/oneOf[subschema #1: ModelCitationTool]/tool_responses/additionalProperties/chunk_ids

      new-required-request-property

    • ▲

      added the new required request property tools/additionalProperties/oneOf[subschema #1: ModelCitationTool]/tool_responses/additionalProperties/offset_end

      new-required-request-property

    • ▲

      added the new required request property tools/additionalProperties/oneOf[subschema #1: ModelCitationTool]/tool_responses/additionalProperties/offset_start

      new-required-request-property

    • ▲

      added the new required request property tools/additionalProperties/oneOf[subschema #1: ModelCitationTool]/tool_responses/additionalProperties/statement

      new-required-request-property

    • ▲

      the tools/additionalProperties/oneOf[subschema #1: ModelCitationTool]/tool_responses/additionalProperties/ request property type/format changed from array/ to object/

      request-property-type-changed

    • ▲

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

      response-body-type-changed

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

  • 84efd317dcde1See the full diff
    • ▲

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

      response-body-type-changed

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

  • 5287337ab0fe1See the full diff
    • ○

      added the new optional request property config_ext_id

      new-optional-request-property

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

  • 43c12480eb1b262See the full diff
    • ▲

      added the pattern ^wrk-[a-zA-Z0-9]{8}$ to the request property workspace_ext_id

      request-property-pattern-added

    • ▲

      the tools/additionalProperties/ request property type/format changed from object/ to /

      request-property-type-changed

    • ●

      removed the request property model

      request-property-removed

    • ●

      removed the request property system_message

      request-property-removed

    • ●

      removed the request property tools/additionalProperties/description

      request-property-removed

    • ●

      removed the request property tools/additionalProperties/name

      request-property-removed

    • ●

      removed the request property tools/additionalProperties/tool_args

      request-property-removed

    • ●

      removed the request property tools/additionalProperties/tool_responses

      request-property-removed

    • ○

      added discriminator to tools/additionalProperties/ request property

      request-property-discriminator-added

    • ○

      added ModelCitationTool RetrievalChunkTool-Input RetrievalFullContextTool-Input to the tools/additionalProperties/ request property oneOf list

      request-property-one-of-added

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