fetch('https://api.search-artemis.com/search', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer YOUR_API_KEY`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    projectId: 'YOUR_PROJECT_ID',
    searchQuery: 'companies that require HIPAA compliance',
    filterQuery: 'company_size == "large"',
    numberOfBatches: 50,
    topK: 4,
  })
})
.then(response => response.json())


{
  "data": {
    "state": "success",
    "tags": [
      "Acme Healthcare Solutions",
      "HealthGuard Technologies",
      "PatientPrivacy Inc.",
      "Compliance Med"
    ],
    "proba": [
      0.95,
      0.89,
      0.87,
      0.85
    ],
    "labels": [
      1,
      0,
      1,
      0
    ]
  },
  "success": true,
  "error": null
}
​
Authorization
string
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your organization’s API key.

​
Body

​
projectId
string
required

The project ID to perform the search on. This is displayed in the “Project Details” card on the project page.

​
searchQuery
string
required

The search query string. For example, “companies that require HIPAA compliance”

​
numberOfBatches
integer
required

The number of batches of synthetic data to generate for the search. This parameter may range from 10 to 70. Increasing this may improve search quality but will increase response time.

​
topK
integer
required

The maximum number of results to return. This parameter may range from 1 to Infinity. Changing this parameter will not affect search time.

​
filterQuery
string

The filter query string which enables you to filter the search results using the filter columns in the dataset. Learn more about filter queries here.

​
Success Response

​
data
object
​
success
true

This field is always true if the search was successful.

​
error
null

This field is always null if the search was successful.

fetch('https://api.search-artemis.com/search', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer YOUR_API_KEY`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    projectId: 'YOUR_PROJECT_ID',
    searchQuery: 'companies that require HIPAA compliance',
    filterQuery: 'company_size == "large"',
    numberOfBatches: 50,
    topK: 4,
  })
})
.then(response => response.json())


{
  "data": {
    "state": "success",
    "tags": [
      "Acme Healthcare Solutions",
      "HealthGuard Technologies",
      "PatientPrivacy Inc.",
      "Compliance Med"
    ],
    "proba": [
      0.95,
      0.89,
      0.87,
      0.85
    ],
    "labels": [
      1,
      0,
      1,
      0
    ]
  },
  "success": true,
  "error": null
}

​
Error Response

​
data
null

This field is always null if the search was not successful.

​
success
false

Indicates the search was not successful.

​
error
object

An error object containing the error message and code.