Skip to content
GigAI

Create a profile

POST
/api/profiles
curl --request POST \
  --url http://127.0.0.1:8765/api/profiles \
  --header 'Content-Type: application/json' \
  --data '{ "label": "Backend", "titles": [ "Software Engineer" ] }'

Create a profile. Every profile but the default one has its own location, work mode, countries and posted window. The first profile is the default and uses the setup settings. The resume: the one named by resume_record_id and resume_revision_id; else the selected profile’s resume. With a master resume stored, a profile that named no resume then gets its own first selection of the master (made by code, with no model call, from the postings its titles match in the local index): it is made after this answer, so the response still shows the selected profile’s resume, GET /api/master/selection lists the profile under pending meanwhile, and GET /api/profiles shows its own resume once it has landed.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
label
required

Profile name.

string
queries

Search queries (default: titles).

array
resume_record_id

Stored resume record.

string
resume_revision_id

Stored resume revision.

string
search_settings

This profile’s own {location, work_mode, countries, max_age_days}; omitted = a copy of the default’s, null = same as default.

object
titles
required

Titles to search (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
Example
{
  "label": "Backend",
  "titles": [
    "Software Engineer"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Success.

Media typeapplication/json
object
key
additional properties
any
Example
{
  "profile": {
    "label": "Backend",
    "profile_id": "prof_1"
  }
}

400

Section titled “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

Section titled “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
Examplegenerated
{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

404

Section titled “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

Section titled “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
Examplegenerated
{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

422

Section titled “422”

Wrong_type

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "wrong_type",
    "message": "..."
  }
}