ALalchemyst-ai
context

Add context data to the context processor

Changed on

This endpoint accepts context data and sends it to a context processor for further handling. It returns a success or error response depending on the result from the context processor.

post/api/v1/context/add

Request

Request body

sourcestring required

The source of the context data

context_type'resource' | 'conversation' | 'instruction' required

Type of context being added

scope'internal' | 'external' required

Scope of the context

webhook_idsstring[]

Optional IDs of webhooks to trigger after the context is processed

Response

Context added successfully

successboolean required
context_idstring required
processed_documentsnumber

Example response

{
  "success": true,
  "context_id": "ctx_01HXYZABC",
  "processed_documents": 2
}

Changes

  • f416d672a956Revision changes
    • info

      added the new optional request property

  • e1cf9b3c78dfRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • warning

      removed the optional property from the response with the status

    • info

      api operation id addContextSync was added

    • info

      the request property with a default value became required

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status