> ## Documentation Index > Fetch the complete documentation index at: https://docs.affinda.com/llms.txt > Use this file to discover all available pages before exploring further. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback: POST https://docs.affinda.com/feedback ```json { "path": "/api-reference/search-&-match/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # Update the config for the logged in user's embeddable job description search tool > Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc. ## OpenAPI ````yaml https://api.affinda.com/static/v3/api_spec.yaml patch /v3/job_description_search/config openapi: 3.0.3 info: description: >- # Introduction Affinda uses the latest advancements in AI technology to rapidly process documents with better-than-human accuracy. This guide covers how to: * Extract structured data from a range of document types * Integrate our solutions into your platform * Manage users *Note: This API spec is for v3 of the API, the deprecated v2 documentation [can be found here](https://api.affinda.com/docs/v2)* > **Important: Use the correct API URL for your region.** Affinda is hosted across multiple instances. Make sure you are sending requests to the correct URL for your account: > | Instance | API Base URL | > |----------|-------------| > | **AUS / Global** | `https://api.affinda.com` | > | **US** | `https://api.us1.affinda.com` | > | **EU** | `https://api.eu1.affinda.com` | > > You can determine your instance from the URL you use to access the Affinda web app (e.g. `app.us1.affinda.com` means you are on the US instance). When using the "Try it" feature, select the matching region from the server dropdown. # Getting Started * Obtain an API key by [signing up for a free-trial](https://app.affinda.com/auth/register) * (Recommended) Download and install one of our client libraries: * [Python](https://github.com/affinda/affinda-python) : `pip install affinda` * [Javascript](https://github.com/affinda/affinda-typescript) : `npm install @affinda/affinda` * [.NET](https://github.com/affinda/affinda-dotnet): `dotnet add package Affinda.API` * [Java](https://github.com/affinda/affinda-java) - [maven repository](https://mvnrepository.com/artifact/com.affinda.api/affinda-api-client) * Without a client library, API requests via HTTP according to the API spec in this documentation version: v3 title: Affinda API contact: email: contact@affinda.com license: name: MIT url: https://raw.githubusercontent.com/affinda/affinda-api-spec/master/LICENSE x-logo: url: https://api.affinda.com/static/documentation/affinda_logo.png backgroundColor: '#FFFFFF' altText: Affinda logo servers: - url: https://{region}.affinda.com description: >- Select the correct server for your instance: api (AUS/Global), api.us1 (US), or api.eu1 (EU). variables: region: default: api description: >- The instance region. Use 'api' for AUS/Global, 'api.us1' for US, or 'api.eu1' for EU. You can find your region in the Affinda web app URL. enum: - api - api.eu1 - api.us1 x-ms-parameter-location: client security: - ApiKeyAuth: [] tags: - name: Documents description: > Operations to upload documents for parsing. A document can be uploaded using `file` or `url`, one of these parameters must be provided. A document can be uploaded to a `workspace` or a `collection`, one of these parameters must also be provided. When uploaded to a workspace, the document's specific type will be predicted and auto classified into one of the collections before being parsed. When uploaded to a collection, the document will be parsed using that collection's extractor. - name: Organizations description: | Operations to manage organizations and organization memberships. Organizations are the top-level entity for managing users and workspaces. - name: Workspaces description: | Operations to manage workspaces. Workspaces group together related collections of documents. - name: Document Types description: > Operations to manage document types. Document types represent specific categories of documents with common extraction patterns, such as invoices or resumes. - name: Data Sources description: > Operations to manage custom mapping data sources. These are used to map from raw data extracted by Affinda AI models onto your own data model. - name: Validation Results description: > Operations to manage validation results. Validation results track the status and outcomes of document validation processes. - name: Usage description: > Operations to retrieve credits consumption. Returns daily credits usage for an organization, optionally narrowed to a single workspace or document type. - name: Tags description: > Operations to manage tags. Tags can be arbitrarily attached to documents to help organize and manage them. - name: Annotations description: > Operations to manually create, update, delete annotations. Together with the data point endpoints, these helps to annotate your documents with arbitrary data, or to edit annotations that were created by the Affinda parser. - name: Webhooks description: > Manage webhook integrations with your apps. Affinda have implemented webhooks to allow the data extracted by Affinda to be 'pushed' to you when an event occurs (e.g. document parsed or document validated), instead of you having to constantly poll our API to 'pull' the data to your system. - name: Search & Match description: > Operations to search through an index of documents and manage indexes via the Affinda Resume Parser API or a client library. Resumes and job descriptions must be explicitly added to an index, which then makes them searchable. - name: Deprecated End Points description: > Deprecated endpoints that are maintained for backward compatibility. These endpoints include Data Point, Collection, and Users functionality that has been superseded by newer APIs. - name: Add x-hidden to endpoints description: > Hidden endpoints not intended for public use. These endpoints include Splitting, Extractor, Organization, and Workspace Memberships & Usage functionality. paths: /v3/job_description_search/config: patch: tags: - Search & Match summary: >- Update the config for the logged in user's embeddable job description search tool description: >- Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc. operationId: updateJobDescriptionSearchConfig requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JobDescriptionSearchConfig' responses: '200': description: Successfully updated configurations. content: application/json: schema: $ref: '#/components/schemas/JobDescriptionSearchConfig' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' default: $ref: '#/components/responses/DefaultError' components: schemas: JobDescriptionSearchConfig: type: object properties: allowPdfDownload: type: boolean nullable: false maxResults: type: integer minimum: 1 nullable: true description: >- Maximum number of results that can be returned. Setting to "null" means no limitation. example: 10 displayJobTitle: type: boolean nullable: false displayLocation: type: boolean nullable: false displayYearsExperience: type: boolean nullable: false displayOccupationGroup: type: boolean nullable: false displayEducation: type: boolean nullable: false displaySkills: type: boolean nullable: false displayLanguages: type: boolean nullable: false displayManagementLevel: type: boolean nullable: false displayKeywords: type: boolean nullable: false weightJobTitle: type: number nullable: false weightLocation: type: number nullable: false weightYearsExperience: type: number nullable: false weightOccupationGroup: type: number nullable: false weightEducation: type: number nullable: false weightSkills: type: number nullable: false weightLanguages: type: number nullable: false weightManagementLevel: type: number nullable: false weightKeywords: type: number nullable: false indices: type: array items: type: string description: List of index names. example: - all-job-descriptions - my-index showIndexDropdown: type: boolean nullable: true description: Controls whether or not the index dropdown is displayed to the user searchToolTheme: type: object allOf: - $ref: '#/components/schemas/ThemeConfig' nullable: true description: Customize the theme of the embeded search tool. userId: type: integer nullable: false readOnly: true description: ID of the logged in user. example: 1234 minimum: 1 username: type: string nullable: false readOnly: true description: Username of the logged in user. example: big.smoke actions: type: array nullable: true description: >- A list of actions to show in the dropdown in the embedded search tool items: $ref: '#/components/schemas/SearchConfigAction' hideToolbar: type: boolean nullable: false description: Hide the reset/import toolbar. hideSidePanel: type: boolean nullable: false description: Hide the entire side panel. customFieldsConfig: type: array nullable: true items: $ref: '#/components/schemas/CustomFieldConfig' distanceUnit: type: string nullable: false description: The unit of distance to use for location based searches example: km enum: - mi - km ThemeConfig: type: object properties: palette: type: object properties: mode: type: string enum: - light - dark background: oneOf: - type: string - type: object properties: default: type: string paper: type: string text: type: object properties: primary: type: string secondary: type: string disabled: type: string divider: type: string primary: $ref: '#/components/schemas/PaletteColorOptions' secondary: $ref: '#/components/schemas/PaletteColorOptions' success: $ref: '#/components/schemas/PaletteColorOptions' annotation: $ref: '#/components/schemas/PaletteColorOptions' error: $ref: '#/components/schemas/PaletteColorOptions' info: $ref: '#/components/schemas/PaletteColorOptions' warning: $ref: '#/components/schemas/PaletteColorOptions' typography: type: object properties: fontFamily: type: string fontSize: oneOf: - type: string - type: number fontWeightRegular: type: string fontWeightMedium: type: string fontWeightBold: type: string borderRadius: type: number fontUrl: type: string SearchConfigAction: type: object required: - label - eventName properties: label: description: Human readable label to display in the UI type: string example: Add to shortlist eventName: description: Name of the event to be triggered type: string example: addToShortlist CustomFieldConfig: type: object required: - dataPoint - weight properties: dataPoint: type: string description: Data point identifier. example: RdNAniIH weight: type: number minimum: 0 maximum: 1 example: 0.5 default: 0.5 RequestError: type: object additionalProperties: false required: - type - errors properties: type: type: string example: validation_error errors: type: array items: type: object required: - attr - code - detail properties: attr: type: string nullable: true example: non_field_errors code: type: string example: unique detail: type: string example: This index name has already been used PaletteColorOptions: type: object required: - main properties: main: type: string light: type: string dark: type: string contrastText: type: string responses: 400Error: description: >- Bad request. If it is a validation error will contain a list of each invalid field content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true 401Error: description: Authorisation error content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true DefaultError: description: UnexpectedError content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true securitySchemes: ApiKeyAuth: type: http scheme: bearer description: >- 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](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register). ````