context

Get status of a context add job

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

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

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

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

  • 510cbb709bed119See the full diff
    • the response's property type changed from string to object for status

      response-property-type-changed

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property / to the response with the status

      response-required-property-added

    • added the required property / to the response with the status

      response-required-property-added

    • api operation id checkStatusForParticularJobInAddContextAsync was added

      api-operation-id-added

    • endpoint added

      endpoint-added