Save preferences and derive the config

PUT

/api/setup

curl --request PUT \
  --url http://127.0.0.1:8765/api/setup \
  --header 'Content-Type: application/json' \
  --data '{ "countries": [ "US" ], "roles": [ "Software Engineer" ] }'

Save preferences and derive the find-jobs config from them.

Request Body^required

Media typeapplication/json

object

budget_usd_per_session

Spend cap per session.

number

cadence_days

Days between discovery runs.

integer

city

City for onsite/hybrid.

string

company_stage_size

Stage/size preference.

string

countries

Country codes.

array

dealbreaker_stack

Stack to avoid.

array

exclude_companies

Companies to skip.

array

industries_exclude

Industries to exclude.

array

industries_include

Industries to include.

array

max_age_days

Ignore postings older than this.

integer

model_target

Model target.

string

must_have_stack

Required stack.

array

profile_id

Save into this profile.

string

roles

required

Job titles to search for (non-empty).

array

titles_to_avoid

Words or phrases: a posting whose title holds one (whole words, any case) is not in this profile’s list.

array

visa_sponsorship_required

Default false.

boolean

watch_companies

Companies to watch.

array

work_mode

Remote | hybrid | onsite (as the wizard offers).

string

Example

{
  "countries": [
    "US"
  ],
  "roles": [
    "Software Engineer"
  ]
}

Responses

200

Success.

Media typeapplication/json

object

key

additional properties

any

Example

{
  "countries": [
    "US"
  ],
  "roles": [
    "Software Engineer"
  ]
}

400

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": "invalid_value",
    "message": "..."
  }
}

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"
  }
}

404

Not_found

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "not_found",
    "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"
  }
}