Allows integration with the HRForecast smartApps from within third-party systems.
\nThese endpoints are only meant to be used from third-party tools and require an API Key. Please use the LudiCloud UI to create an API Key first.
\nPlease replace {{baseUrl}} below with your smartApps link: e.g. https://CLIENT.hrforecast.de
File that you want to upload
\n","value":null}]},"url":"{{baseUrl}}/api/ludicloud/v2/en/external/entities/upload?dropspace={{dropspace_id}}&api_key={{api_key}}","urlObject":{"path":["api","ludicloud","v2","en","external","entities","upload"],"host":["{{baseUrl}}"],"query":[{"key":"dropspace","value":"{{dropspace_id}}"},{"key":"api_key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"494a0150-da99-466e-8d05-63a57d378ec2","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/upload?dropspace={{dropspace_id}}&api_key={{api_key}}","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","upload"],"query":[{"key":"dropspace","value":"{{dropspace_id}}"},{"key":"api_key","value":"{{api_key}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"uploaded\": true\n }\n}"},{"id":"aa931359-e302-494b-b2f1-2f31466addb9","name":"Forbidden Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/dalisoft/Desktop/ftp/users-2-csv.csv"},{"key":"file","type":"file","src":"/Users/dalisoft/Desktop/ftp/users-2.xlsx","disabled":true}]},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/upload?dropspace={{dropspace_id}}&api_key=00000000-0000-0000-0000-000000000000","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","upload"],"query":[{"key":"dropspace","value":"{{dropspace_id}}"},{"key":"api_key","value":"00000000-0000-0000-0000-000000000000"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"errors\": [\n {\n \"message\": \"Forbidden\"\n }\n ]\n}"}],"_postman_id":"ec74f6d6-41c9-4edf-b6cd-75662b289774"},{"name":"Login auth","id":"5eb30fa0-7ecb-4a4b-a0a2-e470f0f7b206","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{USER_EMAIL}}\",\r\n \"password\": \"{{USER_PASSWORD}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{AUTH_LOGIN_URL}}","urlObject":{"host":["{{AUTH_LOGIN_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5eb30fa0-7ecb-4a4b-a0a2-e470f0f7b206"},{"name":"Pipeline Information [ALPHA]","id":"48fbfef4-424a-4260-9a20-d94c22181271","protocolProfileBehavior":{"followRedirects":false,"followOriginalHttpMethod":false,"followAuthorizationHeader":false,"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/pipeline?api_key={{api_key}}&pipeline_id={{pipeline_id}}","urlObject":{"path":["api","ludicloud","v2","{{language}}","external","entities","pipeline"],"host":["{{baseUrl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"pipeline_id","value":"{{pipeline_id}}"}],"variable":[]}},"response":[{"id":"7ca75156-836e-48fd-89c9-363f519f9530","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/pipeline?api_key={{api_key}}&pipeline_id={{pipeline_id}}","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","pipeline"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"pipeline_id","value":"{{pipeline_id}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"pipeline_id\": \"1e1411f8-f97e-4ce2-a34a-8d78d9e121b3\",\n \"import_id\": 301,\n \"status\": \"done\",\n \"start_time\": \"2023-08-24T11:39:20.383Z\",\n \"end_time\": \"2023-08-24T11:39:20.440Z\",\n \"mapping\": {\n \"basic\": {\n \"username\": \"USERNAME *\"\n },\n \"customs\": {\n \"type\": \"TYPE *\",\n \"title\": \"JOB TITLE OR ID *\",\n \"company\": \"COMPANY NAME\",\n \"end_date\": \"END DATE\",\n \"end_date_i\": 8,\n \"start_date\": \"START DATE\",\n \"description\": \"DESCRIPTION\",\n \"end_date_key\": \"END DATE\",\n \"start_date_i\": 7,\n \"start_date_key\": \"START DATE\",\n \"end_date_format\": \"DD.MM.YY\",\n \"start_date_format\": \"DD.MM.YY\"\n }\n },\n \"sumary\": {\n \"type\": \"done\",\n \"message\": \"1 out of 4 rows imported\"\n },\n \"report_download_url\": \"http://localhost:3000/api/smartpeople/v3/en/imports/entities/excel/report/jobs/301\",\n \"details\": [\n {\n \"name\": \"username\",\n \"type\": \"error\",\n \"count\": 3,\n \"reason\": \"notExists\"\n }\n ]\n }\n}"},{"id":"338a2521-4162-4869-b7ac-61656fb14997","name":"Forbidden Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/pipeline?api_key={{api_key}}&pipeline_id={{pipeline_id}}","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","pipeline"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"pipeline_id","value":"{{pipeline_id}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"errors\": [\n {\n \"message\": \"No such pipeline found\"\n }\n ]\n}"}],"_postman_id":"48fbfef4-424a-4260-9a20-d94c22181271"}],"id":"d6e28e01-3871-45a8-bd24-d81b9972a336","description":"Sync your data to smartApps using our files upload feature. This requires that you have created a DropSpace in LudiCloud Setup.
Extract skills from a text
\n","urlObject":{"path":["api","ludicloud","v2","en","external","entities","skill_extraction"],"host":["{{baseUrl}}"],"query":[{"key":"api_key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"aa1f416f-eb61-4894-8d86-89b919da2abe","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"Advanced knowledge of programming languages including JavaScript, HTML5, C++, Java, SQL, and PHP\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/skill_extraction?api_key={{api_key}}","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","skill_extraction"],"query":[{"key":"api_key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"doc_id\": \"eb368b68-d7da-41b6-8a80-7bcd71122328\",\n \"skills_extracted\": [\n {\n \"skill_id\": \"b9a43eb1-8b52-5b5b-a83a-0cd3d103a77a\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n },\n {\n \"skill_id\": \"ad8c5101-c720-5c33-a6f4-826dccce288c\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n },\n {\n \"skill_id\": \"f48c91c8-95d2-5403-99ed-b7dafe6f7466\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n },\n {\n \"skill_id\": \"8c9dd556-44f8-52cb-98c0-d98c901c859d\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n },\n {\n \"skill_id\": \"4370d21f-e4ef-5b5b-9c56-4bd84c5845c9\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n },\n {\n \"skill_id\": \"6597491b-d10b-5a6f-a9c8-e4c1e729c05b\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n },\n {\n \"skill_id\": \"a2dd65aa-1f5b-5076-832c-a60d175623ee\",\n \"skill_level\": 3,\n \"catalog_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proficiency\": 3\n }\n ]\n }\n ]\n}"},{"id":"f2ad7d92-17e5-454b-824d-ea8e8a69385c","name":"Forbidden Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"eb368b68-d7da-41b6-8a80-7bcd71122328\",\n \"text\": \"python java\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/skill_extraction?api_key=00000000-0000-0000-0000-000000000000","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","skill_extraction"],"query":[{"key":"api_key","value":"00000000-0000-0000-0000-000000000000"}]}},"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": 403,\n \"errors\": [\n {\n \"message\": \"Forbidden\"\n }\n ]\n}"}],"_postman_id":"99a2eb81-5ff0-4088-8aaf-fcfa1466cdde"},{"name":"Job standardization","id":"a69577c0-38d4-477d-b2ec-4a69dfea72dd","protocolProfileBehavior":{"followRedirects":false,"followOriginalHttpMethod":false,"followAuthorizationHeader":false,"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"My AWS Cloud Engineer\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/ludicloud/v2/en/external/entities/job_standardization?api_key={{api_key}}","description":"Get a standardized job title for your raw job title
\n","urlObject":{"path":["api","ludicloud","v2","en","external","entities","job_standardization"],"host":["{{baseUrl}}"],"query":[{"key":"api_key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"2b5d4981-1564-4768-853b-17ce9525419c","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"My AWS Cloud Engineer\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/job_standardization?api_key={{api_key}}","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","job_standardization"],"query":[{"key":"api_key","value":"{{api_key}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"doc_id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"standard_job_id\": \"d9117635-08f2-4808-bb7a-238ab199292e\",\n \"standard_job_name\": \"Cloud engineer (AWS)\",\n \"standard_job_catalog_id\": \"11012bff-9a69-49e2-b5e1-455891e75186\"\n }\n ]\n}"},{"id":"a65a1d19-db4e-4c8e-a9e7-4c6fbcb93ec7","name":"Forbidden Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"My AWS Cloud Engineer\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/job_standardization?api_key=00000000-0000-0000-0000-000000000000","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","job_standardization"],"query":[{"key":"api_key","value":"00000000-0000-0000-0000-000000000000"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"errors\": [\n {\n \"message\": \"Forbidden\"\n }\n ]\n}"}],"_postman_id":"a69577c0-38d4-477d-b2ec-4a69dfea72dd"},{"name":"Job standardization Copy","id":"5b974eff-8c66-4658-a02a-e9a6072b3f20","protocolProfileBehavior":{"followRedirects":false,"followOriginalHttpMethod":false,"followAuthorizationHeader":false,"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"My AWS Cloud Engineer\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/ludicloud/v2/en/external/entities/job_standardization?api_key={{api_key}}","description":"Get a standardized job title for your raw job title
\n","urlObject":{"path":["api","ludicloud","v2","en","external","entities","job_standardization"],"host":["{{baseUrl}}"],"query":[{"key":"api_key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"88e20538-3c49-4a7b-972a-5e3a76ce50bb","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"My AWS Cloud Engineer\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/job_standardization?api_key={{api_key}}","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","job_standardization"],"query":[{"key":"api_key","value":"{{api_key}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"doc_id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"standard_job_id\": \"d9117635-08f2-4808-bb7a-238ab199292e\",\n \"standard_job_name\": \"Cloud engineer (AWS)\",\n \"standard_job_catalog_id\": \"11012bff-9a69-49e2-b5e1-455891e75186\"\n }\n ]\n}"},{"id":"64feb925-5f1d-4411-91b2-5becc31fb8d4","name":"Forbidden Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"docs\": [\n {\n \"id\": \"4ebad77f-0e0c-4152-957b-2add21148c77\",\n \"text\": \"My AWS Cloud Engineer\",\n \"language_code\": \"en\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/api/ludicloud/v2/{{language}}/external/entities/job_standardization?api_key=00000000-0000-0000-0000-000000000000","host":["{{baseUrl}}"],"path":["api","ludicloud","v2","{{language}}","external","entities","job_standardization"],"query":[{"key":"api_key","value":"00000000-0000-0000-0000-000000000000"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": 403,\n \"errors\": [\n {\n \"message\": \"Forbidden\"\n }\n ]\n}"}],"_postman_id":"5b974eff-8c66-4658-a02a-e9a6072b3f20"}],"id":"f5e79957-d0c8-4aba-97bb-eb8ce6572193","description":"Allows you to use our custom NLP and ML models for integration with third-party tools.
\n","_postman_id":"f5e79957-d0c8-4aba-97bb-eb8ce6572193"}]}