context

Get status of a context add job

Changed on

Returns the status and result of a context add job by job id.

get/api/v1/context/add-async/{id}/status

Request

Path parameters

idstring required

Job ID to check status for

Response

Job status and result

successboolean required
jobIdstring required
statusstring required
resultobject

Result of the job (if available)

attemptsMadenumber
failedReasonstring
finishedOnnumber
processedOnnumber

Example response

{
  "success": true,
  "jobId": "job_01HXYZABC",
  "status": "completed",
  "attemptsMade": 1,
  "finishedOn": 1712345678901,
  "processedOn": 1712345670000
}

Changes

    • breaking

      the response's property type changed from string to object for status

    • info

      api operation id checkStatusForParticularJobInAddContextAsync was added

    • 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

      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

    • info

      the response property became required for 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

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to string for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id checkStatusForParticularJobInAddContextAsync removed and replaced with