---
title: "Create a signed URL for the embeddable resume search tool"
method: POST
path: "/v3/resume_search/embed"
tags: ["Search & Match"]
---

# Create a signed URL for the embeddable resume search tool

`POST /v3/resume_search/embed`

Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable resume search tool.

## Request body

- object
  - `configOverride` ResumeSearchConfig
    - `allowPdfDownload` boolean
    - `maxResults` integer, nullable — Maximum number of results that can be returned. Setting to "null" means no limitation.
    - `displayJobTitle` boolean
    - `displayLocation` boolean
    - `displayYearsExperience` boolean
    - `displayOccupationGroup` boolean
    - `displayEducation` boolean
    - `displaySkills` boolean
    - `displayLanguages` boolean
    - `displayManagementLevel` boolean
    - `displayKeywords` boolean
    - `weightJobTitle` number
    - `weightLocation` number
    - `weightYearsExperience` number
    - `weightOccupationGroup` number
    - `weightEducation` number
    - `weightSkills` number
    - `weightLanguages` number
    - `weightManagementLevel` number
    - `weightKeywords` number
    - `indices` string[] — List of index names.
    - `showIndexDropdown` boolean, nullable — Controls whether or not the index dropdown is displayed to the user
    - `searchToolTheme` ThemeConfig
      - `palette` object
        - `mode` 'light' | 'dark'
        - `background` union
          - string
          - object
            - `default` string
            - `paper` string
        - `text` object
          - `primary` string
          - `secondary` string
          - `disabled` string
        - `divider` string
        - `primary` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `secondary` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `success` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `annotation` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `error` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `info` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `warning` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
      - `typography` object
        - `fontFamily` string
        - `fontSize` union
          - string
          - number
        - `fontWeightRegular` string
        - `fontWeightMedium` string
        - `fontWeightBold` string
      - `borderRadius` number
      - `fontUrl` string
    - `userId` integer — ID of the logged in user.
    - `username` string — Username of the logged in user.
    - `actions` SearchConfigAction[], nullable — A list of actions to show in the dropdown in the embedded search tool
      - `label` string, required — Human readable label to display in the UI
      - `eventName` string, required — Name of the event to be triggered
    - `hideToolbar` boolean — Hide the reset/import toolbar.
    - `hideSidePanel` boolean — Hide the entire side panel.
    - `customFieldsConfig` CustomFieldConfig[], nullable
      - `dataPoint` string, required — Data point identifier.
      - `weight` number, required
    - `distanceUnit` 'mi' | 'km' — The unit of distance to use for location based searches

## Response `200`

Successfully created a signed URL.

- ResumeSearchEmbed
  - `url` string — The signed URL for the embedable search tool.

## Other responses

- `401` — Authorisation error
- `default` — UnexpectedError

---

[API](https://skmtc.net/affinda/apis/affinda-api-2.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api-2/versions/6772e50cb58e/schema)