Skip to content
GigAI

Get the resumes folder

GET
/api/resumes-folder
curl --request GET \
  --url http://127.0.0.1:8765/api/resumes-folder

The resumes folder: where master.md and the headerless PDFs are kept. One visible folder (default ~/Documents/GigAI/resumes; a GigAI home other than ~/.gigai defaults to <home>/resumes) that holds the master resume’s file (master.md) and the PDFs rendered without a header, named <company>-<role>-<YYYY-MM-DD>.pdf. Since 0.1.11.4 a job’s resume markdown is no longer written here: it is resume.md in the job’s own folder (GET /api/jobs-folder); the <company>-<role>-<YYYY-MM-DD>.md files already there are left as they are. It never holds a name or contact details: a PDF made with the Generate PDF form’s header is saved only where the user saves it. GigAI replaces a file there only when it is exactly what GigAI last wrote. source is default or setting. files is {markdown, pdf}: a file name or null (markdown: only a file written before 0.1.11.4).

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
profile_id
string

Optional (0.1.11.9: the job names its files); taken with job_identity and picks nothing.

job_identity
string

The job: adds files, the names of that job’s files in the folder.

Responses

Section titled “Responses”

200

Section titled “200”

Success.

Media typeapplication/json
object
schema_version
required
Allowed value: scout-resumes-folder-response:1
key
additional properties
any
Example
{
  "default": "~/Documents/GigAI/resumes",
  "exists": true,
  "path": "/home/you/Documents/GigAI/resumes",
  "schema_version": "scout-resumes-folder-response:1",
  "shown": "~/Documents/GigAI/resumes",
  "source": "default"
}

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”

Target_unavailable

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

422

Section titled “422”

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