Choose the jobs folder

PUT

/api/jobs-folder

curl --request PUT \
  --url http://127.0.0.1:8765/api/jobs-folder \
  --header 'Content-Type: application/json' \
  --data '{ "path": "~/Applications" }'

Choose the jobs folder. Job folders already written stay in the old folder. A relative path, a path that is a file, or a folder inside the GigAI home (GigAI’s own store) answers 422 invalid_value; a folder that cannot be created or written answers 409 folder_unwritable.

Request Body^required

Media typeapplication/json

object

path

required

An absolute folder path, or one that starts with ~; created when missing. Empty or null: the default folder.

string

Example

{
  "path": "~/Applications"
}

Responses

200

Success.

Media typeapplication/json

object

schema_version

required

Allowed value: scout-jobs-folder-response:1

key

additional properties

any

Example

{
  "default": "~/Documents/GigAI/jobs",
  "exists": true,
  "path": "/home/you/Applications",
  "schema_version": "scout-jobs-folder-response:1",
  "shown": "~/Applications",
  "source": "setting"
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

409

Folder_unwritable

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "folder_unwritable",
    "message": "..."
  }
}

415

Unsupported_media_type: writes need Content-Type: application/json.

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

422

Unknown_key, wrong_type, invalid_value

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "unknown_key",
    "message": "..."
  }
}