post /v2/autocomplete/skills

Autocomplete skills

Auto complete the skill search.
Endpoint POST /v2/autocomplete/skills
Credit cost 0.1 credits / call
Response Synchronous — up to 15 results
When to use Power a type-ahead input for skill filters when searching people

Quickstart#

Skills map to peopleFilters.skills on Search People. Use this endpoint to suggest valid skill values as the user types.

curl -X POST "https://api.ocean.io/v2/autocomplete/skills" \
  -H "X-Api-Token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "python",
    "limit": 5
  }'
import requests

response = requests.post(
    'https://api.ocean.io/v2/autocomplete/skills',
    headers={'X-Api-Token': 'YOUR_API_TOKEN'},
    json={'query': 'python', 'limit': 5},
)
data = response.json()
const response = await fetch('https://api.ocean.io/v2/autocomplete/skills', {
  method: 'POST',
  headers: { 'X-Api-Token': 'YOUR_API_TOKEN', 'Content-Type': 'application/json' },
  body: JSON.stringify({ query: 'python', limit: 5 }),
});
const data = await response.json();

Example response:

{
  "skills": ["Python", "Python Programming", "Python Django", "Python Flask", "Python Data Analysis"]
}

Pass the selected value directly into the skills filter on your people search request. Skill names are case-normalised — use the returned casing exactly.


Parameters#

Parameter Type Description
query string Required. Beginning of the skill name.
limit integer Optional. Max results to return. Default 5, maximum 15.

Authorizations

apiToken string
x-api-token string

Body application/json

query string Required
Beginning of the skill name
limit integer
Number of skills to return. Default is 5 if not specified, maximum is 15.

Responses

200 Successful Response
Array of found skills. Returns empty array if no results
Array of string
400 Bad Request
detail enum Required
"Conflicting API tokens provided in query parameters and headers"
402 Payment Required
detail enum Required
"Insufficient credits"
403 Forbidden
detail enum Required
"API token should be provided in headers or query parameters""Current API token is not registered in our database"
404 Not found
422 Validation Error
Array of ValidationError
Array of string | integer
string | integer
msg string Required
type string Required
input any
object