HEhere
Manage Jobs

Create a job input

Changed on

Creates a new input for a job

post/jobs/{jobId}/inputs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /jobs/{jobId}/inputs
  • Auth
    • API key in query parameter access_token
    • or HTTP bearer

Path parameters

jobIdstring required

The unique identifier of the job.

Headers

X-Response-Mode'regular' | 'paginated'

Optional response mode switch for list endpoints. If omitted, defaults to regular. - regular: return a flat list (legacy behavior). - paginated: return a page wrapper with items and nextPageToken.

Request body

type'UploadUrl' required

The type is "UploadUrl"

s3Keystring

The type of the Input

urlstring

The presigned url for uploading the data.

Example request

{
  "type": "UploadUrl",
  "s3Key": "import/h3TGlF/part_1.csv",
  "url": "https://foo.com/import/h3TGlF/part_1.csv"
}

Response

The job inputs

OR

Example response

{
  "type": "UploadUrl",
  "s3Key": "import/h3TGlF/part_1.csv",
  "url": "https://foo.com/import/h3TGlF/part_1.csv"
}

Changes

  • 88b5563c7e8bRevision changes
    • info

      added the non-success response with the status

  • b0f3c1c4fc93Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      added the new optional header request parameter X-Response-Mode