context

Asynchronously queue context data to add to the context processor

Changed on

This endpoint accepts context data and queues it for asynchronous processing by the context processor. It returns a success or error response depending on the queuing result.

post/api/v1/context/add-async

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 queued successfully

queuedboolean required
jobIdstring required

Example response

{
  "queued": true,
  "jobId": "context-add-123456"
}

Changes

    • info

      added the new optional request property

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      api operation id addContextAsync was added

    • info

      the request property with a default value became required

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status