POST
/
v3
/
job_description_search
/
embed
Create a signed URL for the embeddable job description search tool
curl --request POST \
  --url https://{region}.affinda.com/v3/job_description_search/embed \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "configOverride": {
    "allowPdfDownload": true,
    "maxResults": 10,
    "displayJobTitle": true,
    "displayLocation": true,
    "displayYearsExperience": true,
    "displayOccupationGroup": true,
    "displayEducation": true,
    "displaySkills": true,
    "displayLanguages": true,
    "displayManagementLevel": true,
    "displayKeywords": true,
    "weightJobTitle": 123,
    "weightLocation": 123,
    "weightYearsExperience": 123,
    "weightOccupationGroup": 123,
    "weightEducation": 123,
    "weightSkills": 123,
    "weightLanguages": 123,
    "weightManagementLevel": 123,
    "weightKeywords": 123,
    "indices": [
      "all-job-descriptions",
      "my-index"
    ],
    "showIndexDropdown": true,
    "searchToolTheme": {
      "palette": {
        "mode": "light",
        "background": "<string>",
        "text": {
          "primary": "<string>",
          "secondary": "<string>",
          "disabled": "<string>"
        },
        "divider": "<string>",
        "primary": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        },
        "secondary": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        },
        "success": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        },
        "annotation": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        },
        "error": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        },
        "info": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        },
        "warning": {
          "main": "<string>",
          "light": "<string>",
          "dark": "<string>",
          "contrastText": "<string>"
        }
      },
      "typography": {
        "fontFamily": "<string>",
        "fontSize": "<string>",
        "fontWeightRegular": "<string>",
        "fontWeightMedium": "<string>",
        "fontWeightBold": "<string>"
      },
      "borderRadius": 123,
      "fontUrl": "<string>"
    },
    "actions": [
      {
        "label": "Add to shortlist",
        "eventName": "addToShortlist"
      }
    ],
    "hideToolbar": true,
    "hideSidePanel": true,
    "customFieldsConfig": [
      {
        "dataPoint": "RdNAniIH",
        "weight": 0.5
      }
    ],
    "distanceUnit": "km"
  }
}'
{
  "url": "https://app.affinda.com/job-description-search?signature=eyJhbGxvd19wZGZkGZ"
}

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Body

application/json

Response

200
application/json

Successfully created a signed URL.

The response is of type object.