People

Create a resume upload session

Create a resume upload session

Required scopes: people:write

Server-mediated signed upload-session. Returns a single-path, short-lived (≤5 min), one-shot signed Storage upload_url. Upload the PDF or DOCX bytes to that URL with an HTTP PUT, then call the finalize endpoint to attach and parse the resume. Secret keys (ys_sk_*) only.

Example (curl):

curl -X POST https://api.yardstick.team/v1/people/per_abc123/resume_upload_sessions \
  -H 'Authorization: Bearer ys_sk_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"file_name":"resume.pdf","size_bytes":48211,"content_type":"application/pdf"}'

Example (TypeScript):

await fetch(
  "https://api.yardstick.team/v1/people/per_abc123/resume_upload_sessions",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.YS_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      file_name: "resume.pdf",
      size_bytes: 48211,
      content_type: "application/pdf",
    }),
  },
).then((r) => r.json());
post/v1/people/{person_id}/resume_upload_sessions

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/people/{person_id}/resume_upload_sessions
  • Auth: HTTP bearer

Path parameters

person_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

file_namestring required
size_bytesinteger required
content_typestring

Response

Resume upload session created.

idstring required

Display id, e.g. rus_<base32>

object'resume_upload_session' required
person_idstring required

Canonical per_... person id.

upload_urlstring required

Single-path, short-lived (≤5 min), one-shot signed Storage URL. PUT the resume bytes here, then call finalize.

object_pathstring required

Server-minted storage object key for the resume.

expires_atstring required

ISO-8601 UTC expiry of the signed upload URL.

status'pending' required

Changes

No recorded changes to this operation across all 1 revision of this API.