Skip to content
GigAI

Rank a run's postings

POST
/api/runs/{run_id}/rank
curl --request POST \
  --url http://127.0.0.1:8765/api/runs/example/rank \
  --header 'Content-Type: application/json' \
  --data '{ "start": true }'

Rank a run’s postings against the selected profile’s resume (start / cancel / read).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
run_id
required
string

A run id from GET /api/runs (run_…).

Request Body

Section titled “Request Body”
Media typeapplication/json
object
cancel

True stops one.

boolean
cost_cap_usd

Spend cap.

number
profile_id

Rank for this profile.

string
run_id

Must match the URL.

string
schema_version

Optional request schema version.

string
start

True starts a ranking.

boolean
Example
{
  "start": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Success.

Media typeapplication/json
object
key
additional properties
any
Example
{
  "state": "idle"
}

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”

Invalid_value, wrong_type, unknown_key

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