Skip to main content
Resume a job that has been paused with a blocked_insufficient_credits status. Plangrep automatically pauses processing when your organization runs out of credits mid-job. After adding credits to your account, call this endpoint to restart processing from where it left off — no re-upload is required.

​
Authentication

Include your API key as Authorization: Bearer YOUR_API_KEY in the request headers.

​
Endpoint

POST https://plangrep.com/api/open/v1/jobs/{jobId}/resume

​
Path Parameters

​
jobId
string
required
The unique identifier of the job to resume. The job must currently have a status of blocked_insufficient_credits.

​
Request Body

This endpoint takes no request body.

​
Example Request

curl --request POST \
  --url https://plangrep.com/api/open/v1/jobs/job_01hy3m8qtn2e5r7k9p0w4x1def/resume \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

​
Response Fields

​
job
Job
required
The updated job object with the new status reflecting that processing has resumed.

​
Example Response

{
  "job": {
    "id": "job_01hy3m8qtn2e5r7k9p0w4x1def",
    "externalId": "order-7890",
    "status": "processing",
    "projectId": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
    "limits": {
      "maxDeclaredBytes": 10000000000,
      "maxFiles": 100
    },
    "pageCount": 204,
    "successfulPageCount": 112,
    "billing": {
      "creditsDebited": 112
    },
    "files": [
      {
        "id": "file_xyz789",
        "fileName": "architectural_drawings.pdf",
        "status": "processing"
      }
    ],
    "resultUrl": null,
    "error": null,
    "createdAt": "2024-11-02T09:00:00.000Z",
    "updatedAt": "2024-11-02T10:15:42.000Z",
    "completedAt": null,
    "expiresAt": "2024-11-09T09:00:00.000Z"
  }
}
This endpoint only works on jobs with a current status of blocked_insufficient_credits. Calling it on jobs in any other status — including active, terminal, or cancelled jobs — will return an error. Verify that you have added sufficient credits to your account before calling this endpoint, or the job may be paused again shortly after resuming.