> ## Documentation Index > Fetch the complete documentation index at: https://docs.pulze.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve > Get a job by id ## OpenAPI ````yaml /renderflow/api-reference/openapi.json get /jobs/{id} openapi: 3.1.0 info: title: RenderFlow API version: 2.0.0 description: Render farm management. servers: - url: http://localhost:44442/api/v1 description: The service on this machine. Answers without a credential - url: http://your-server:44442/api/v1 description: A farm's server. Needs an API key - url: https://your-server:44445/api/v1 description: A farm's server set up with TLS. Needs an API key security: - bearerAuth: [] paths: /jobs/{id}: get: tags: - Jobs summary: Retrieve description: Get a job by id operationId: getJob parameters: - schema: type: string pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 required: true name: id in: path responses: '200': description: The job content: application/json: schema: $ref: '#/components/schemas/Job' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Missing or invalid credentials content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Not permitted for this credential content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ApiError' '422': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Unhandled server error content: application/json: schema: $ref: '#/components/schemas/ApiError' components: schemas: Job: type: object properties: id: type: string pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 name: type: string default: '' user_id: type: - string - 'null' pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 api_key_id: type: - string - 'null' pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 description: The API key that submitted it pool_id: type: - string - 'null' pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 group_id: type: - string - 'null' pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 storage_id: type: - string - 'null' pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 status: $ref: '#/components/schemas/Status' icon: type: - string - 'null' description: type: string default: '' thumbnail: type: - string - 'null' color: type: - string - 'null' tags: type: array items: type: string default: [] priority: type: number default: 50 steps: type: array items: $ref: '#/components/schemas/JobStep' default: [] dependencies: type: array items: $ref: '#/components/schemas/JobDependency' default: [] metadata: type: array items: $ref: '#/components/schemas/JobMetadata' default: [] env: $ref: '#/components/schemas/JobEnv' notifications: type: array items: $ref: '#/components/schemas/JobNotification' default: [] cleanup: type: object properties: type: type: string default: none delay: type: integer default: 0 default: {} assets: type: array items: $ref: '#/components/schemas/Asset' default: [] errors: type: array items: type: object properties: {} additionalProperties: {} progress: $ref: '#/components/schemas/Progress' schedule_date: type: - integer - 'null' example: 1785846207000 created_at: type: - integer - 'null' example: 1785846207000 started_at: type: - integer - 'null' example: 1785846207000 finished_at: type: - integer - 'null' example: 1785846207000 archived_at: type: - integer - 'null' example: 1785846207000 removed_at: type: - integer - 'null' example: 1785846207000 required: - id - status - progress - name - description - tags - priority - steps - dependencies - metadata - notifications - cleanup - assets ApiError: type: object properties: error: type: string tag: type: string description: The catalog entry this failure is, when it is one title: type: string description: The catalog entry's title detail: type: string description: What happened this time, and what to do issues: type: array items: type: object properties: path: type: array items: anyOf: - type: string - type: number message: type: string required: - path - message required: - error Status: type: string enum: - working - finishing - pending - preparing - submitting - failed - archived - suspended - scheduled - queued - completed - disabled - unknown JobStep: type: object properties: id: type: string pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 index: type: integer default: 0 name: type: string default: '' type: $ref: '#/components/schemas/TaskType' reqs: type: array items: $ref: '#/components/schemas/StepRequirement' default: [] props: type: array items: $ref: '#/components/schemas/JobProp' default: [] output: type: array items: $ref: '#/components/schemas/JobStepOutput' default: [] inputs: type: array items: $ref: '#/components/schemas/JobStepInput' enabled: type: boolean skipped: type: boolean nodes: type: array items: $ref: '#/components/schemas/JobNode' default: [] whitelisted_nodes: type: array items: type: string default: [] blacklisted_nodes: type: array items: type: string default: [] description: Machines kept off this step, whatever else they could render master_node_id: type: - string - 'null' description: >- The machine this step's render is pinned to. A distributed render's dispatcher. Null means the matcher chooses task_info: $ref: '#/components/schemas/TaskInfo' settings: $ref: '#/components/schemas/JobStepSettings' tasks: type: array items: anyOf: - type: string pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 - type: object properties: {} additionalProperties: {} default: [] progress: $ref: '#/components/schemas/Progress' wait: anyOf: - $ref: '#/components/schemas/StepWait' - type: 'null' required: - id - type - task_info - settings - progress - index - name - reqs - props - output - nodes - whitelisted_nodes - blacklisted_nodes - tasks JobDependency: type: object properties: id: type: string default: '' job_id: type: string default: '' resolved: type: boolean default: false additionalProperties: {} required: - id - job_id - resolved JobMetadata: type: object properties: id: type: string default: '' label: type: string default: '' value: anyOf: - type: string - type: number - type: boolean - type: 'null' type: type: string default: '' JobEnv: type: object additionalProperties: type: string description: >- Environment variables for every application the job starts, over the app's own. `$NAME` reads the value the app would have had. example: OCIO: //studio/config/aces.ocio PATH: $PATH;//studio/tools/bin JobNotification: type: object properties: id: type: string default: '' enabled: type: boolean default: false channel: type: string default: '' type: type: string default: '' label: type: string default: '' value: type: string default: '' description: A channel id, an email address, or a machine id required: - id - enabled - channel - type - label - value Asset: type: object properties: id: type: - string - 'null' type: type: - string - 'null' description: >- What kind of reference this is (bitmap, xref, proxy, ies, animaproj, root) source: type: - string - 'null' description: >- Where the parser found the reference; empty on plugin-reported assets parent: type: - string - 'null' description: Owning scene object, on plugin-reported assets filepath: type: - string - 'null' filename: type: - string - 'null' target_filename: type: - string - 'null' description: >- Set when `retarget` is true: the collision-free name to copy the file to retarget: type: - boolean - 'null' description: True when another asset shares the filename with different content duplicate: type: - boolean - 'null' state: $ref: '#/components/schemas/AssetState' size: type: - number - 'null' hash: type: - string - 'null' Progress: type: object properties: percent: type: - number - 'null' elapsed_time: type: - number - 'null' remaining_time: type: - number - 'null' total_render_time: type: - number - 'null' average_time: type: - number - 'null' info: type: - string - 'null' TaskType: type: string enum: - renderflow.test - 3dsmax.render - 3dsmax.scene_manager.render - arnold.render - after.render - blender.render - cinema4d.render - houdini.batch - houdini.mantra - houdini.husk - imager - ffmpeg - denoise - autograph.render - fusion.render - harmony.render - keyshot.render - maya.render - nuke.render - renderman.render - premiere.render - media_encoder.encode - davinci.render - shell - python - unreal - vray.dr.spawner - redshift.render - sketchup.render - rhino.render - vray_standalone - vantage.render - vred.render - comfyui.render - agentic - 3dsmax.script - blender.script - cinema4d.script - maya.script - houdini.script - nuke.script - fusion.script - 3dsmax.export - maya.export - blender.export - cinema4d.export - renderflow.custom_plugin - renderflow.benchmark StepRequirement: type: object properties: id: type: string default: '' enabled: type: boolean default: true category: $ref: '#/components/schemas/ReqCategory' category_type: anyOf: - type: number - type: string default: 0 value: {} validation_level: $ref: '#/components/schemas/ValidationLevel' additionalProperties: {} JobProp: anyOf: - $ref: '#/components/schemas/JobPropFile' - $ref: '#/components/schemas/JobPropFileBrowser' - $ref: '#/components/schemas/JobPropFilePicker' - $ref: '#/components/schemas/JobPropResolution' - $ref: '#/components/schemas/JobPropCamera' - $ref: '#/components/schemas/JobPropFrame' - $ref: '#/components/schemas/JobPropTiled' - $ref: '#/components/schemas/JobPropImageOutput' - $ref: '#/components/schemas/JobPropRenderSettings' - $ref: '#/components/schemas/JobPropSelector' - $ref: '#/components/schemas/JobPropConfig' - $ref: '#/components/schemas/JobPropScriptFile' - $ref: '#/components/schemas/JobPropScriptSnippet' - $ref: '#/components/schemas/JobPropDistributed' - $ref: '#/components/schemas/JobPropImageSource' - $ref: '#/components/schemas/JobPropImageExport' - $ref: '#/components/schemas/JobPropVideoExport' - $ref: '#/components/schemas/JobPropDenoise' - $ref: '#/components/schemas/JobPropArgs' - $ref: '#/components/schemas/JobPropWorkList' - $ref: '#/components/schemas/JobPropCustomPlugin' - $ref: '#/components/schemas/JobPropScriptParams' - $ref: '#/components/schemas/JobPropSceneManager' - $ref: '#/components/schemas/JobPropPrompt' - $ref: '#/components/schemas/JobPropGeneric' JobStepOutput: type: object properties: id: type: string default: '' key: type: string default: '' name: type: string default: '' type: $ref: '#/components/schemas/JobArtifactType' source: $ref: '#/components/schemas/JobStepOutputSource' declared: $ref: '#/components/schemas/JobArtifact' resolved: $ref: '#/components/schemas/JobArtifact' required: - type - source additionalProperties: {} JobStepInput: type: object properties: id: type: string default: '' target_prop_key: type: string source_step_id: type: string source_output_key: type: string required: - target_prop_key - source_step_id - source_output_key additionalProperties: {} JobNode: type: object properties: id: type: string pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 node_id: type: string pattern: ^[a-fA-F0-9]{24}$ example: 68b1f0c2a4d3e5f6a7b8c9d0 name: type: string default: '' status: type: string default: '' attempts: type: integer default: 0 required: - node_id - name - status - attempts TaskInfo: type: object properties: mode: type: - string - 'null' enum: - frame_range - tile_grid - once_per_node - null description: How tasks are generated; frame_range when absent step: type: number default: 1 order: type: number default: 0 all_list: type: string default: '' description: Every frame the step covers, as ranges. The order its tasks are in pending_list: type: string default: '' suspended_list: type: string default: '' working_list: type: string default: '' completed_list: type: string default: '' failed_list: type: string default: '' all_count: type: number default: 0 pending_count: type: number default: 0 suspended_count: type: number default: 0 working_count: type: number default: 0 failed_count: type: number default: 0 completed_count: type: number default: 0 chunks: type: - array - 'null' items: type: string description: >- Frame range per chunk index, for DCCs that batch frames into one task additionalProperties: {} required: - step - order - all_list - pending_list - suspended_list - working_list - completed_list - failed_list - all_count - pending_count - suspended_count - working_count - failed_count - completed_count JobStepSettings: type: object properties: limit: type: integer default: 0 description: Max nodes on this step; 0 means unlimited maximum: type: integer default: 0 fixed_limit: type: boolean default: false max_batch_size: type: integer minimum: 1 default: 1 min_batch_size: type: integer minimum: 1 fixed_batch_size: type: boolean default: false force_finish: type: integer default: 2 timeout: type: integer default: 60000 max_attempts: type: integer default: 1 wait_for_previous: type: boolean default: true depends_on: type: array items: type: string description: >- The earlier steps this one waits on, by step id, in place of the step before it. Each must be earlier in the job run_on: type: string enum: - success - always - failure default: success description: Whether a settled predecessor lets this step run manual_start: type: boolean description: Hold this step until somebody starts it resumable: type: boolean default: false run_on_each_node: type: boolean default: false copy_to_repository: type: boolean description: >- Stage this step's files into the repository; omitted is true. False renders them where they already are, for a scene every node can already read perforce: $ref: '#/components/schemas/StepPerforceSource' locked: type: boolean description: Only an operator who may author templates edits this step assembles_step_id: type: string description: The render step whose tiles this Image step assembles benchmark: type: object properties: definition_id: type: string type: type: string enum: - vray - vray-gpu - redshift - cinebench - blender - blender-gpu - custom required: - definition_id - type additionalProperties: {} description: >- What this step measures: its finished tasks become the machines' benchmark scores default: {} additionalProperties: {} StepWait: type: object properties: reason: type: string enum: - license - requirements description: What the step waits for license: type: string description: The licence's name, on a license wait title: type: string default: '' at: type: integer default: 0 example: 1785846207000 required: - reason - title - at AssetState: type: - integer - 'null' enum: - 0 - 1 - 2 - 3 - 4 - 5 - null ReqCategory: type: integer enum: - 0 - 1 - 2 - 3 - 4 default: 0 ValidationLevel: type: - integer - 'null' enum: - 0 - 1 - 2 - 3 - null JobPropFile: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - file.input value: $ref: '#/components/schemas/JobPropFileValue' props: $ref: '#/components/schemas/JobPropFileSettings' required: - type - value - props additionalProperties: {} JobPropFileBrowser: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - file.browser value: $ref: '#/components/schemas/JobPropFileValue' props: $ref: '#/components/schemas/JobPropFileBrowserSettings' required: - type - value - props additionalProperties: {} JobPropFilePicker: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - file.picker value: $ref: '#/components/schemas/JobPropFileValue' props: $ref: '#/components/schemas/JobPropFilePickerSettings' required: - type - value - props additionalProperties: {} JobPropResolution: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - resolution value: $ref: '#/components/schemas/JobPropResolutionValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropCamera: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - camera value: $ref: '#/components/schemas/JobPropCameraValue' props: $ref: '#/components/schemas/JobPropCameraSettings' required: - type - value - props additionalProperties: {} JobPropFrame: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - frame value: $ref: '#/components/schemas/JobPropFrameValue' props: $ref: '#/components/schemas/JobPropFrameSettings' required: - type - value - props additionalProperties: {} JobPropTiled: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - tiled value: $ref: '#/components/schemas/JobPropTiledValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropImageOutput: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - image.output value: $ref: '#/components/schemas/JobPropOutputValue' props: $ref: '#/components/schemas/JobPropOutputSettings' required: - type - value - props additionalProperties: {} JobPropRenderSettings: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - render.settings value: type: object properties: values: type: object additionalProperties: {} default: {} additionalProperties: {} props: allOf: - $ref: '#/components/schemas/JobPropSettings' - type: object properties: declarations: type: array items: $ref: '#/components/schemas/FieldDecl' additionalProperties: {} required: - type - value - props additionalProperties: {} JobPropSelector: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - name value: $ref: '#/components/schemas/JobPropSelectorValue' props: $ref: '#/components/schemas/JobPropSelectorSettings' required: - type - value - props additionalProperties: {} JobPropConfig: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - config value: $ref: '#/components/schemas/JobPropFileValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropScriptFile: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - script.file value: $ref: '#/components/schemas/JobPropScriptFileValue' props: $ref: '#/components/schemas/JobPropFileBrowserSettings' required: - type - value - props additionalProperties: {} JobPropScriptSnippet: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - script.snippet value: $ref: '#/components/schemas/JobPropScriptSnippetValue' props: $ref: '#/components/schemas/JobPropFileBrowserSettings' required: - type - value - props additionalProperties: {} JobPropDistributed: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - distributed value: $ref: '#/components/schemas/JobPropDistributedValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropImageSource: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - image.source value: $ref: '#/components/schemas/JobPropImageSourceValue' props: $ref: '#/components/schemas/JobPropImageSourceSettings' required: - type - value - props additionalProperties: {} JobPropImageExport: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - image.export value: $ref: '#/components/schemas/JobPropImageExportValue' props: $ref: '#/components/schemas/JobPropImageExportSettings' required: - type - value - props additionalProperties: {} JobPropVideoExport: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - video.export value: $ref: '#/components/schemas/JobPropVideoExportValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropDenoise: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - denoise.export value: $ref: '#/components/schemas/JobPropDenoiseValue' props: $ref: '#/components/schemas/JobPropImageExportSettings' required: - type - value - props additionalProperties: {} JobPropArgs: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - args value: $ref: '#/components/schemas/JobPropArgsValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropWorkList: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - work.list value: $ref: '#/components/schemas/JobPropWorkListValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropCustomPlugin: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - custom.plugin value: $ref: '#/components/schemas/JobPropCustomPluginValue' props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropScriptParams: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - script.params value: $ref: '#/components/schemas/JobPropScriptParamsValue' props: $ref: '#/components/schemas/JobPropScriptParamsSettings' required: - type - value - props additionalProperties: {} JobPropSceneManager: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - scene-manager value: type: object properties: setup: type: - object - 'null' properties: {} additionalProperties: {} index: type: number default: 0 additionalProperties: {} props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropPrompt: type: object properties: id: type: - string - 'null' key: type: - string - 'null' description: >- Stable identifier the public API maps flat recipe fields onto (e.g. rop_node) name: type: string default: '' callback: $ref: '#/components/schemas/JobCallbackType' category: type: - number - 'null' v: type: - number - 'null' type: type: string enum: - prompt value: type: string props: $ref: '#/components/schemas/JobPropSettings' required: - type - value - props additionalProperties: {} JobPropGeneric: type: object properties: {} additionalProperties: {} description: >- A prop this build does not describe: an unknown type, or a known type whose shape has drifted JobArtifactType: type: string enum: - image.single - image.sequence - file.single - file.sequence - folder - data JobStepOutputSource: anyOf: - type: object properties: prop_key: type: string required: - prop_key additionalProperties: {} - type: object properties: discovered: type: boolean enum: - true required: - discovered additionalProperties: {} JobArtifact: type: - object - 'null' properties: path: type: string default: '' folder: type: string default: '' basename: type: string default: '' extension: type: string default: '' frames: type: - object - 'null' properties: start: type: number end: type: number step: type: - number - 'null' digits: type: - number - 'null' required: - start - end additionalProperties: {} width: type: - number - 'null' height: type: - number - 'null' fps: type: - number - 'null' naming: type: - object - 'null' properties: type: type: number path: type: string padding: type: number delimiter: type: string separate_folders: type: boolean single: type: boolean element_delimiter: type: - string - 'null' extensionless: type: - boolean - 'null' beauty_element: type: - string - 'null' required: - type - path - padding - delimiter - separate_folders - single additionalProperties: {} description: How a render's frames are named, as the farm predicts them additionalProperties: {} StepPerforceSource: type: object properties: server: type: string description: Id of a server under Settings → Perforce workspace: type: string description: The artist's workspace; nodes sync the revisions it has root: type: string description: The artist's local project folder; the scene path is read against it change: type: integer minimum: 1 description: A changelist to sync instead of what the workspace has shelf: type: integer minimum: 1 description: The artist's edits, shelved at submit; nodes lay them over the sync required: - server - workspace - root description: Sync this step's scene from Perforce on each node instead of staging it JobCallbackType: type: - string - 'null' enum: - pre-setup - post-setup - pre-task - post-task - pre-render - pre-frame - post-frame - post-render - null JobPropFileValue: type: object properties: path: type: string default: '' original_path: type: - string - 'null' sequence: $ref: '#/components/schemas/JobPropFileSequence' perforce: $ref: '#/components/schemas/PerforceFacts' additionalProperties: {} JobPropFileSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: boolean default: false options: type: array items: $ref: '#/components/schemas/JobPropFileOption' default: [] file_filter: type: array items: $ref: '#/components/schemas/FileFilter' default: [] provides: $ref: '#/components/schemas/SubmitProvides' host_id: type: - string - 'null' sequence: type: boolean default: false port: type: number default: 0 placeholder: type: - string - 'null' additionalProperties: {} JobPropFileBrowserSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' file_filter: type: array items: $ref: '#/components/schemas/FileFilter' default: [] placeholder: type: - string - 'null' additionalProperties: {} JobPropFilePickerSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' options: type: array items: $ref: '#/components/schemas/JobPropFilePickerOption' default: [] file_filter: type: array items: $ref: '#/components/schemas/FileFilter' default: [] placeholder: type: - string - 'null' additionalProperties: {} JobPropResolutionValue: type: object properties: width: type: number default: 0 height: type: number default: 0 x: type: - number - 'null' 'y': type: - number - 'null' w: type: - number - 'null' h: type: - number - 'null' additionalProperties: {} JobPropSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' additionalProperties: {} JobPropCameraValue: type: object properties: id: anyOf: - type: string - type: number - type: 'null' name: type: string default: '' additionalProperties: {} JobPropCameraSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' options: type: array items: $ref: '#/components/schemas/JobPropCameraValue' default: [] additionalProperties: {} JobPropFrameValue: type: object properties: type: type: number default: 0 description: 0 single, 1 range, 2 list frame: type: string default: '0' step: type: integer minimum: 1 default: 1 fps: type: number default: 30 order: type: string enum: - linear - reverse - endpoints - sparse - every_nth - random description: >- Which frames go out first: linear, reverse, first-middle-last then the rest, first-middle-last then the centres of every span (sparse), every Nth then the rest, or random. Omitted is linear; set at submit order_step: type: integer minimum: 2 description: 'For order every_nth: every Nth frame goes first. Omitted is 5' split: type: string enum: - shot - chunks - job description: >- How the range becomes tasks, one of the prop's `splits`: shot (a task a shot), chunks (by the step's batch size) or job (one task). Omitted is the first of `splits` single: type: number range: type: array items: type: number list: type: string additionalProperties: {} JobPropFrameSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' modes: type: array items: type: string enum: - single - range - list default: - single - range - list hide_step: type: - boolean - 'null' splits: type: array items: type: string enum: - shot - chunks - job description: >- The ways the step can divide its range, the first the default. Absent is chunks by the batch size additionalProperties: {} JobPropTiledValue: type: object properties: tiles_x: type: number default: 4 tiles_y: type: number default: 1 additionalProperties: {} JobPropOutputValue: type: object properties: type: type: number default: 0 description: 'Output slot: 0 is the main image, the rest are render elements' enabled: type: boolean default: false path: type: string default: '' additionalProperties: {} JobPropOutputSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' file_filter: type: array items: $ref: '#/components/schemas/FileFilter' default: [] padding: type: number default: 4 delimiter: type: string default: . format: $ref: '#/components/schemas/RenderFormat' separate_folders: type: boolean default: false directory_only: type: - boolean - 'null' node: type: - object - 'null' properties: name: type: string description: >- What the renderer takes to execute this node and no other (Nuke's -X) required: - name description: >- The node inside the scene that writes this output. A Nuke Write or CopyCat. Present only where switching the output off leaves that node out of the render tokens: type: object additionalProperties: type: string description: >- Each token in the path and its value, as the host application resolved it for this job's item: the path is the pattern, filled with these additionalProperties: {} FieldDecl: type: object properties: key: type: string kind: type: string label: type: - string - 'null' default: {} required: type: - boolean - 'null' min: type: - number - 'null' max: type: - number - 'null' step: type: - number - 'null' units: type: - string - 'null' options: type: - array - 'null' items: $ref: '#/components/schemas/FieldOption' filter: type: - array - 'null' items: $ref: '#/components/schemas/FileFilter' pattern: type: - string - 'null' placeholder: type: - string - 'null' readonly: type: - boolean - 'null' multiline: type: - boolean - 'null' show_if: type: - array - 'null' items: type: object properties: key: type: string value: {} required: - key additionalProperties: {} group: type: - string - 'null' provides: type: - object - 'null' properties: payload: type: boolean default: false live: type: boolean default: false file: type: boolean default: false opens: type: - boolean - 'null' gui: type: - boolean - 'null' detail: type: - boolean - 'null' additionalProperties: {} description: What can describe the scene this field holds. File declarations only host_id: type: - string - 'null' description: Which application that scene belongs to required: - key - kind additionalProperties: {} JobPropSelectorValue: type: object properties: id: anyOf: - type: string - type: number - type: 'null' name: type: string default: '' color: type: - string - 'null' label: type: - string - 'null' none: type: - boolean - 'null' description: >- Not one of the items. Picking it returns the step to the scene as it stands additionalProperties: {} JobPropSelectorSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' options: type: array items: $ref: '#/components/schemas/JobPropSelectorValue' default: [] batch: type: - boolean - 'null' additionalProperties: {} JobPropScriptFileValue: type: object properties: lang: $ref: '#/components/schemas/ScriptLanguage' path: type: string default: '' additionalProperties: {} JobPropScriptSnippetValue: type: object properties: code: type: string default: '' lang: type: - string - 'null' language: type: - string - 'null' additionalProperties: {} JobPropDistributedValue: type: object properties: nodes: type: - array - 'null' items: type: string additionalProperties: {} JobPropImageSourceValue: type: object properties: path: type: string default: '' sequence: $ref: '#/components/schemas/JobPropFileSequence' additionalProperties: {} JobPropImageSourceSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' file_filter: type: array items: $ref: '#/components/schemas/FileFilter' default: [] additionalProperties: {} JobPropImageExportValue: type: object properties: element: type: string default: '' description: A render element by name; empty is the whole image format: type: string enum: - exr - png - jpg - tif - tga default: jpg size: type: object properties: mode: type: string enum: - full - width - height - scale default: full value: type: number default: 0 description: >- Pixels for `width` and `height`; a factor for `scale`, so 0.5 is half size. Ignored by `full` default: mode: full value: 0 additionalProperties: {} quality: type: - number - 'null' depth: type: - string - 'null' enum: - '8' - '16' - half - float - null description: >- What the format can hold: 8 or 16 for png and tif, float for tif and exr, half for exr. Absent writes 8-bit, or half for an exr colorspace: type: - string - 'null' path: type: string default: '' additionalProperties: {} JobPropImageExportSettings: type: object properties: enabled: type: boolean default: false required: type: boolean default: false optional: type: boolean default: true hidden: type: boolean readonly: type: - boolean - 'null' padding: type: number default: 4 delimiter: type: string default: . additionalProperties: {} JobPropVideoExportValue: type: object properties: preset: type: string enum: - h264 - h265 - prores_422hq - prores_4444 - dnxhr_hq - custom default: h264 fps: type: - number - 'null' description: Frames per second. Absent takes the source's frame rate path: type: string default: '' description: The movie file; empty means beside the source, named after it command: type: string default: '' description: ffmpeg's arguments, read only by the `custom` preset entries: type: - array - 'null' items: type: object properties: id: type: string default: '' enabled: type: boolean default: true flag: type: string default: '' value: type: string default: '' quote: type: string default: '' additionalProperties: {} description: >- The custom line as arguments, for the submitter. Nothing on the node reads it additionalProperties: {} JobPropDenoiseValue: type: object properties: elements: type: array items: type: string default: [] description: >- Elements to denoise by name: an EXR part, a channel group such as `diffuse`, or `beauty`. Empty denoises the first, which is the beauty albedo: type: string default: '' description: >- The element that is the albedo pass. Empty denoises from colour alone normal: type: string default: '' description: The element that is the normal pass. Needs an albedo beside it clean_aux: type: boolean default: false description: >- Denoise the albedo and normal first, for passes that are noisy themselves quality: type: string enum: - high - balanced - fast default: high device: type: string enum: - auto - cpu - gpu default: auto description: >- `auto` takes the fastest device on the machine; `gpu` fails on a machine without one path: type: string default: '' description: >- The file written per frame. Empty means beside the source, named `.denoised` additionalProperties: {} JobPropArgsValue: type: object properties: args: type: string default: '' entries: type: - array - 'null' items: type: object properties: id: type: string default: '' enabled: type: boolean default: true key: type: string default: '' value: type: string default: '' additionalProperties: {} additionalProperties: {} JobPropWorkListValue: type: object properties: type: type: string enum: - range - count - items range: type: string count: type: integer items: type: array items: {} offset: type: integer description: 'Task copies only: where this slice starts in the step''s list' required: - type additionalProperties: {} JobPropCustomPluginValue: type: object properties: id: type: string version: type: string required: - id - version additionalProperties: {} JobPropScriptParamsValue: type: object properties: values: type: object additionalProperties: {} default: {} additionalProperties: {} JobPropScriptParamsSettings: allOf: - $ref: '#/components/schemas/JobPropSettings' - type: object properties: declarations: type: array items: $ref: '#/components/schemas/FieldDecl' additionalProperties: {} JobPropFileSequence: type: - object - 'null' properties: start_frame: type: number default: 0 end_frame: type: number default: 0 digits: type: number default: 0 pattern: type: string default: '' display: type: string default: '' additionalProperties: {} PerforceFacts: type: object properties: port: type: string user: type: string workspace: type: string description: >- The artist's workspace; the farm reads its view for the depot path and syncs its revisions root: type: string description: The artist's local project folder opened: type: integer description: Files the artist has checked out or added under `root` scene_submitted: type: boolean description: >- False when the scene file is only added or not in Perforce; absent when the host could not tell shelf: type: integer minimum: 1 description: The changelist those files were shelved in at submit required: - port - workspace - root JobPropFileOption: type: object properties: id: type: string default: '' path: type: string default: '' soft_id: type: string default: '' updated_at: type: number default: 0 type: type: string enum: - offline - live default: offline port: type: - number - 'null' additionalProperties: {} FileFilter: type: object properties: name: type: string default: '' extensions: type: array items: type: string default: [] additionalProperties: {} SubmitProvides: type: object properties: payload: type: boolean default: false live: type: boolean default: false file: type: boolean default: false opens: type: - boolean - 'null' gui: type: - boolean - 'null' detail: type: - boolean - 'null' default: payload: false live: false file: true additionalProperties: {} JobPropFilePickerOption: type: object properties: name: type: string default: '' path: type: string default: '' additionalProperties: {} RenderFormat: type: - object - 'null' properties: type: type: string default: '' props: type: array items: $ref: '#/components/schemas/RenderFormatProp' default: [] additionalProperties: {} FieldOption: type: object properties: value: anyOf: - type: string - type: number - type: boolean label: type: - string - 'null' required: - value additionalProperties: {} ScriptLanguage: type: - string - 'null' enum: - maxscript - mel - python - powershell - bash - batch - null RenderFormatProp: type: object properties: name: type: string default: '' class: type: string default: '' value: {} additionalProperties: {} securitySchemes: bearerAuth: type: http scheme: bearer description: An API key from Settings, API Keys. A caller on this machine needs none. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.