WOworldbank
Job Types

Create PDF generation job

Changed on

Convenience endpoint for creating PDF generation jobs. Automatically sets job_type to 'generate_pdf'. This is equivalent to POST /jobs with job_type='generate_pdf' in the payload.

post/jobs/generate_pdf

Request

Request body

project_idinteger required

Project ID for which to generate the PDF

priorityinteger

Job priority

max_attemptsinteger

Maximum retry attempts

Example request

{
  "project_id": 123,
  "options": {}
}

Response

Job created successfully

statusstring
messagestring
uuidstring

Example response

{
  "status": "success",
  "message": "Job created successfully",
  "job": {
    "payload": {
      "project_id": 123,
      "options": {}
    },
    "result": {
      "pdf_path": "/path/to/project_123.pdf",
      "project_id": 123,
      "generated_at": "2025-01-11 16:30:45"
    }
  }
}

Changes

  • 7f334b22fc50Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

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

    • breaking

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

    • warning

      added the new generate_microdata_resource enum value to the / response property for the response status

    • warning

      added the new generate_pdf enum value to the / response property for the response status

    • warning

      added the new hello_world enum value to the / response property for the response status

    • warning

      added the new import_indicator_data enum value to the / response property for the response status

    • warning

      added the new import_microdata enum value to the / response property for the response status

    • warning

      added the new publish_project enum value to the / response property for the response status

  • 1ff58dcd71a4Revision changes
    • warning

      added the new held enum value to the / response property for the response status