Home
Search and Match
The RChilli Search & Match API enhances your ability to find and match candidates and jobs with greater relevance and accuracy compared to traditional database searching methods.
API Information
An API (or Application Programming Interface) is the code that allows applications to talk to each other.
Search and Match
The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
Get Document Ids
This API is used to get all the indexed document ID's.

Overview
RChilli is a global leader in Parsing, Matching, and Data Enrichment solutions, seamlessly integrating with recruiting platforms to enhance efficiency and accuracy.
Product Use-Cases
RChilli products cater to a wide range of use cases, allowing users to choose the most suitable solutions based on their specific requirements.
Resume Parser
The RChilli Resume Parser is a scalable solution designed to enhance user experience by efficiently extracting candidate data across 200+ fields through a REST API.
Job Parser
The RChilli Job Parser 3.1 is a scalable solution designed to streamline job data extraction by efficiently processing job descriptions and vacancies through a REST API.
Search and Match
The RChilli Search & Match API enhances your ability to find and match candidates and jobs with greater relevance and accuracy compared to traditional database searching methods.
- API Information
  An API (or Application Programming Interface) is the code that allows applications to talk to each other.
  - API Authentication
    Search and Match API uses private user key (index key) to authenticate requests. To authenticate the call to an API endpoint, there are only 3 steps:
  - Search and Match
    The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
    - Parse and Index
      To search resume's and JD's using RChilli Search and Match API, you require to parse the resume/JD and index them.
    - Simple Search
      The Simple Search API method empowers you to make your document searchable with a string query (must contain entities) without specifying search parameters.
    - Free Text Search
      FreeTextSearch method is used to search random text on the indexed Resume or JD.
    - Boolean Search
      In the boolean (advance) search, unlike simple search, you can customize your search by specifying search entities like - Job Profile, Company, Degree, etc. and apply boolean condition as necessary.
    - Match
      This API finds Resumes/Job Descriptions matching your input documents.
    - Match with ID
      This API finds Resumes/Job descriptions matching your input documents ID's.
    - Skill Gap Analysis
      In a Skill Gap Analysis API call, a JD document is matched with a resume, and it returns the matching and the missing skills in the resume.
    - One To One Match
      This API matches resume with JD or JD with Resume and responds the detailed matching score.
    - Match with Multiple Sub-User Ids
      This API finds Resumes/Job descriptions that matches your input documents and provided sub user ids.
    - Check Document Index
      This API is used to check whether a document is indexed or not with given document ID.
    - Get Document Ids
      This API is used to get all the indexed document ID's.
    - Get Document Detail
      This API is used to get a particular indexed document detail by providing document ID.
    - Delete
      This API is used to delete indexed files, from the database, by providing document ID.
    - Delete All Documents
      This API is used to delete all indexed files from the database based on the API parameter.
    - Analyze
      The Analyze query is an extension of the c_RChilli_search_match_API_Endpoints_simple_search.html. It analyzes the search string and brings out all the search keywords separately for a more refined result of your query in a simple search.
    - Index Count
      This API is used to returns the number of documents indexed for an Index key.
    - Suggestions
      This API is used to returns the suggestions for different search fields like JobProfile, Skill, and Degree.
    - Spell Checking
      If you give any wrong input while searching, this API will check and correct it.
    - Get Sub User Ids List
      This API returns list of all sub user ID's.
    - Update Index
      The Update Index API allows you to update a block of JSON or a specific entity within a resume or job description (JD) without requiring document parsing through the ResumeParser or JDParser API.
- Features
  The following topics in this section describe the features of the Search and Match.
- Language Support
  RChilli Search and Match supports searching in multiple languages, it does not require any separate configuration. The Search and Match auto-identifies the languages of the Resume/JD and extracts the information.
- Response Schema
  The following table describe the Search and Match fields.
- Request Example
  To get the search and match output data, send a POST request using search and match endpoints, methods, and parameters.
- Response Example
  Follow the below sample search and match response in the JSON format.
- Error Code
  This topic lists the error codes of Search and Match Error Code.
Taxonomy
RChilli Taxonomy 3.0 offers an extensive and meticulously curated collection of skills and job profiles, providing rich, related information for enhanced job and resume searching capabilities.
Resume Redactor
RChilli Resume Redactor API helps in masking resumes before sending them to the employer.
ERP Integration
The components of RChilli application can be integrated with the Oracle HCM Cloud, Oracle PeopleSoft, Salesforce, and SAP Application.
Partner Panel User Guide
RChilli provides a dedicated portal for the partner's to manage their company details.
Plugins
The RChilli provides Plugins, such as Resume_Templater_plugin.html, Document_Converter_plugin.html, NER_Tagger_plugin.html, Contact Extractor, GeoLocation_plugin.html, Job_Zone_Plugin.html, and flexisense_requests_plugin_overview.html that extend the capabilities of the RChilli products.
RChilli Marketplace
The resume parser output can be enriched by activating the other application workflows that are listed on the Enrichment Marketplace such as Lusha, BOLD, Toofr, Rchilli Redact, LLM Parser, etc.
Plan Subscription and Cost
Details on the transaction costs for using RChilli API, along with instructions on how to subscribe to a new plan or upgrade an existing one.
Run in Postman
You can quickly get started with RChilli APIs using Postman.
Release Notes
Release notes comprise new features, improvements, and bug fixes for the following RChilli products.
Glossary
The glossary includes terms and definitions in RChilli Knowledge Center.

Get Document Ids

This API is used to get all the indexed document ID's.

API URL

The Get Document Ids API uses the below URL:

https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/getDocumentIds

API Endpoint

The Get Document Ids API uses the below endpoint:

/getDocumentIds

API Method

The Get Document Ids API uses only POST method.

API Request Type

The Get Document Ids API uses JSON request type.

API Request Headers


Header	Data Type	Description
Content-Type	string	Indicates the input type of the incoming request body. The only supported value is `application/json`.

API Parameters

To execute Get Document Ids API, the following parameters in the JSON request are needed:


Name	Type	Description	Remarks
indexType	String	Type of the file i.e Resume or JD	Required
indexKey	String	Use your user key as shared by RChilli team	Required
subUserId	String	Your user's unique_ID Note: Make sure that there is no space in your subuser_id	Optional
pageSize	Integer	Number of records return in one API call: Default 50 maximum 500 Contact support@rchilli.com to update the limit. For more details, click Pagination.	Optional
pageStart	Integer	Start index of record to return. Can be used for paging when multiple record are searched. Default is 0. For more details, click Pagination	Optional

JSON Request For Get Document Ids - Resume

{
  "index": {
    "indexKey": "Your user key",
    "indexType": "Resume",
    "subUserId": "user 1"
  },
  "pageStart": 0,
  "pageSize": 10
}

JSON Response For Get Document Ids - Resume

{
  "count": 12,
  "pageStart": 0,
  "pageSize": 10,
  "records": [
    {
      "id": "Document Id 1"
    },
    {
      "id": "Document Id 2"
    },
    {
      "id": "Document Id 3"
    },
    {
      "id": "Document Id 4"
    },
    {
      "id": "Document Id 5"
    }
  ]
}

JSON Request For Get Document Ids - JD

{
  "index": {
    "indexKey": "Your user key",
    "indexType": "JD",
    "subUserId": "user 1"
  },
  "pageStart": 0,
  "pageSize": 10
}

JSON Response For Get Document Ids - JD

{
  "count": 12,
  "pageStart": 0,
  "pageSize": 10,
  "records": [
    {
      "id": "Document Id 1"
    },
    {
      "id": "Document Id 2"
    },
    {
      "id": "Document Id 3"
    },
    {
      "id": "Document Id 4"
    },
    {
      "id": "Document Id 5"
    }
  ]
}