> ## 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.

# Reserve

> Take a job id and its repository folder before submitting. For a scene that has to be written there first



## OpenAPI

````yaml /renderflow/api-reference/openapi.json post /jobs/reserve
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/reserve:
    post:
      tags:
        - Jobs
      summary: Reserve
      description: >-
        Take a job id and its repository folder before submitting. For a scene
        that has to be written there first
      operationId: reserveJob
      responses:
        '200':
          description: The id to submit as `job_id`, and the folder it names
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobReservation'
        '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'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    JobReservation:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
          description: >-
            Submit with this as `job_id`. Until then it names a folder in the
            repository and nothing else
        folder:
          type: string
          description: >-
            The job's repository folder, as the *server* addresses it. A caller
            on another OS resolves its own through the fleet settings
      required:
        - id
        - folder
    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
  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.