context

Asynchronously queue context data to add to the context processor

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

Response

Context queued successfully

queuedboolean required
jobIdstring required

Example response

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

Changes

Changed in 3 of the 29 revisions of this API.38

    • the request property context_type became required

      request-property-became-required

    • the request property documents became required

      request-property-became-required

    • the request property source became required

      request-property-became-required

    • the request property scope with a default value became required

      request-property-became-required-with-default

    • the response property jobId became required for the status 201

      response-property-became-required

    • the response property message became required for the status 400

      response-property-became-required

    • the response property queued became required for the status 201

      response-property-became-required

    • the response property status became required for the status 400

      response-property-became-required

    • the response property success became required for the status 400

      response-property-became-required

    • api operation id addContextAsync was added

      api-operation-id-added

    • endpoint added

      endpoint-added