-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
4494 lines (4433 loc) · 140 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Talent API · API Reference
description: >-
<p>API Support: <a href="support@radix.ai">support@radix.ai</a> | Website:
<a href="https://www.radix.ai">https://www.radix.ai</a></p>
<p>Job and profile matching using Artificial Intelligence.</p>
<h1>What is it?</h1>
<p>Talent API is a system that allows retrieving jobs recommendations for a
profile or profiles recommendations for a job.<br>
There are three types of entities involved:</p>
<ul>
<li>The <code>job</code>: a JSON document describing a job offer.</li>
<li>The <code>profile</code>: a JSON document describing a user
profile.</li>
<li>The <code>match</code>: a JSON document describing a link between a job
and a profile. Getting started Here is a description of a<br>
basic use of the API using curl. In the examples, words between brackets need to be replaced by the appropriate value.</li>
</ul>
<h4>Credentials</h4>
<p>You need a <code>client_id</code> and a <code>client_secret</code> in
order to have access to the API. If you don't have credentials, please<br>
contact us at <a href="hello@radix.ai">hello@radix.ai</a>. These credentials
will also come with the scope you are allowed to use.</p>
<p>Using these, you can authenticate at the /auth endpoint and receive an
access_token. This access_token will be needed<br>
for the next requests.</p>
<p>The request should look like</p>
<pre><code>curl -X POST \
https://[server-url]/auth \
-H 'Content-Type: application/json' \
-d '{
"client_id": "[client_id]", \
"client_secret": "[client_secret]", \
"scope":"tapi/ALL"
}'
</code></pre>
<p>The response will be</p>
<pre><code>{
"access_token":"eyJjIs7iOiJ[...]vQZUUhw2fsg",
"expires_in":3600,
"token_type":"Bearer"
}
</code></pre>
<h4>Sending data</h4>
<p>Before being able to request recommendations, you need to provide data.
The minimum is a profile and a job.</p>
<h4>Send a job</h4>
<p>Here is a sample request of how to send us a job.</p>
<p>The example uses the smallest set of fields necessary for the query to
work, but you should fill as many of them as<br>
possible.</p>
<p>The field client_data can be used to send fields that are specific to
your corporation that cannot be mapped to the API<br>
specification. Please note that using client specific fields is discouraged
if your fields are non-critical or can be<br>
translated into predefined fields.</p>
<pre><code>curl -X POST \
http://[server-url]/jobs \
-H 'Authorization: Bearer eyJjIs7iOiJ[...]vQZUUhw2fsg' \
-H 'Content-Type: application/json' \
-d '{
"external_id" : "12345",
"title": "A job title",
"addresses": ["The job address"],
"publication_datetime" : "2020-02-12 00:02:00",
"expiration_datetime" : "2020-02-12 00:02:00",
"may_be_recommended" : true,
"may_receive_recommendations" : true
}'
</code></pre>
<p>You will receive the following response, confirming that we received the
job and processed it correctly:</p>
<pre><code>{
"message": "Job successfully received. Recommendations will be available once the job has been processed."
}
</code></pre>
<h4>Send a profile</h4>
<p>In the same fashion, to send us a profile</p>
<pre><code>curl -X POST \
http://[server-url]/profiles \
-H 'Authorization: Bearer eyJjIs7iOiJ[...]vQZUUhw2fsg' \
-H 'Content-Type: application/json' \
-d '{
"external_id" : "6789",
"addresses": ["The addresses where the candidate lives."],
"publication_datetime" : "2008-02-12 00:02:00",
"expiration_datetime" : "2008-02-12 00:02:00",
"may_be_recommended" : true,
"may_receive_recommendations" : true
}'
</code></pre>
<p>And the response will be</p>
<pre><code>{
"message": "Profile successfully received. Recommendations will be available once the profile has been processed.",
}
</code></pre>
<h4>Get a recommendation</h4>
<p>Now that there is a job and a profile in the system, you can ask for a
recommendation. For example, in order to get the<br>
best jobs for the profile you just uploaded, you can do the following
request</p>
<pre><code>curl -X GET \
http://[server-url]/profile/123456789/jobs \
-H 'Authorization: Bearer eyJjIs7iOiJ[...]vQZUUhw2fsg' \
-H 'Content-Type: application/json' \
</code></pre>
<p>The response will contain a list of the best jobs for that profile, in
the following form</p>
<pre><code>[
{
"resource_id": 12345
"score": 0.87
"resource": {
"external_id" : "12345",
"title": "A job title",
"addresses": ["The job address"],
"publication_datetime" : "2020-02-12 00:02:00",
"expiration_datetime" : "2020-02-12 00:02:00",
"may_be_recommended" : true,
"may_receive_recommendations" : true
},
"match_explanation": {
}
},
...
]
</code></pre>
<p>These recommendations are based on the data that you included when
uploading jobs and profiles to Talent API. To receive<br>
high quality recommendations, make sure to fill as many fields as possible
when uploading entities.</p>
<h4>Send a match indicator</h4>
<p>If you want the recommendation to improve based on your user behaviour,
you need to send us <code>match indicators</code>. A match<br>
indicator represents a link between a profile and a job. As an example, if
the user with profile_id <code>6789</code> had a look at<br>
the job page with id <code>12345</code>, you can send us the following
match:</p>
<pre><code>curl -X POST \
https://[server-url]/matches \
-H 'Authorization: Bearer eyJraWQiOi[...]Mou8GdpvnA'
-H 'Content-Type: application/json'
-d '{
'profile_id':'6789',
'job_id':'12345',
'match_actor':'CANDIDATE',
'match_datetime':'2020-03-14T21:37:38.414Z',
'match_type':'PAGEVIEW'
}'
</code></pre>
<p>That way, we are aware of user interactions inside of your data.</p>
<h4>View your data status</h4>
<p>To have a look at what you currently sent us, call the
<code>status</code> endpoint:</p>
<pre><code>curl -X GET \
https://[server-url]/status \
-H 'Authorization: Bearer eyJraWQiOi[...]Mou8GdpvnA'
-H 'Content-Type: application/json'
</code></pre>
version: '2024-04-02'
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://api.talentapi.com
tags:
- description: Recommend jobs and profiles.
name: Recommend
- description: Search through uploaded jobs and profiles.
name: Search
- description: Add or update job and profile data.
name: Add or Update
- description: Delete a job or profile.
name: Delete
- description: Fetch a job or profile.
name: Fetch
- description: Authenticate with the Talent API.
name: Authentication
- description: Fetch status information about uploaded jobs and profiles.
name: Status
- name: Skills
- name: Evaluate
paths:
/auth:
post:
tags:
- Authentication
summary: Authenticate with the Talent API.
operationId: Authentication_accessTokenPost
description: >-
Authenticate with the Talent API. After authenticating with your Access
Key ID and Secret Access Key, you will receive an Access Token that can
be used to authorize all subsequent requests by including the header
<code>Authorization: Bearer {access_token}.</code>
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
required: true
responses:
'200':
description: r_description
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationAccessTokenPostResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend/job/{job_id}/profiles:
post:
tags:
- Recommend
summary: Recommend profiles for a given job.
operationId: Recommend_jobProfilesPost
security:
- JWTBearer: []
description: Recommend profiles for a given job.
parameters:
- required: true
schema:
title: Job Id
type: string
name: job_id
in: path
- description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example, if
TalentAPI is called within a web application, then, the URL of the
page on which the matches will be displayed, can be used as the
value of X-Response-Target. Thus, the API calls can be separated
according to the target URL.
required: false
schema:
title: X-Response-Target
description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example,
if TalentAPI is called within a web application, then, the URL of
the page on which the matches will be displayed, can be used as
the value of X-Response-Target. Thus, the API calls can be
separated according to the target URL.
type: string
name: x-response-target
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JobRecommendResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend/profile/{profile_id}/jobs:
post:
tags:
- Recommend
summary: Recommend jobs for a given profile.
operationId: Recommend_jobsForProfile
security:
- JWTBearer: []
description: Recommend jobs for a given profile.
parameters:
- required: true
schema:
title: Profile Id
type: string
name: profile_id
in: path
- description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example, if
TalentAPI is called within a web application, then, the URL of the
page on which the matches will be displayed, can be used as the
value of X-Response-Target. Thus, the API calls can be separated
according to the target URL.
required: false
schema:
title: X-Response-Target
description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example,
if TalentAPI is called within a web application, then, the URL of
the page on which the matches will be displayed, can be used as
the value of X-Response-Target. Thus, the API calls can be
separated according to the target URL.
type: string
name: x-response-target
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendJobsForProfileResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend-master/profile/{profile_id}/jobs:
post:
tags:
- Recommend
summary: Recommend jobs for a given profile (master).
operationId: Recommend_jobsForProfileMaster
security:
- JWTBearer: []
description: >-
Recommend jobs for a given profile returning only the master results
(experimental)
parameters:
- required: true
schema:
title: Profile Id
type: string
name: profile_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendJobsForProfileMasterResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend-master/job/{job_id}/profiles:
post:
tags:
- Recommend
summary: Recommend profiles for a given job (master).
operationId: Recommend_profilesForJobMasterPost
security:
- JWTBearer: []
description: >-
Recommend profiles for a given job returning only the master results
(experimental)
parameters:
- required: true
schema:
title: Job Id
type: string
name: job_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendProfilesForJobMasterPostResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend-master/job/{job_id}/jobs:
post:
tags:
- Recommend
summary: Recommend jobs for a given job (master).
operationId: Recommend_jobMasterJobs
security:
- JWTBearer: []
description: >-
Recommend jobs for a given job returning only the master results
(experimental)
parameters:
- required: true
schema:
title: Job Id
type: string
name: job_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendJobMasterJobsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend-master/profile/{profile_id}/profiles:
post:
tags:
- Recommend
summary: Recommend profiles for a given profile (master).
operationId: Recommend_profilesForProfileMaster
security:
- JWTBearer: []
description: >-
Recommend profiles for a given profile returning only the master results
(experimental)
parameters:
- required: true
schema:
title: Profile Id
type: string
name: profile_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendProfilesForProfileMasterResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend/job/{job_id}/jobs:
post:
tags:
- Recommend
summary: Recommend job for a given job.
operationId: Recommend_jobForJob
security:
- JWTBearer: []
description: Recommend jobs for a given job.
parameters:
- required: true
schema:
title: Job Id
type: string
name: job_id
in: path
- description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example, if
TalentAPI is called within a web application, then, the URL of the
page on which the matches will be displayed, can be used as the
value of X-Response-Target. Thus, the API calls can be separated
according to the target URL.
required: false
schema:
title: X-Response-Target
description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example,
if TalentAPI is called within a web application, then, the URL of
the page on which the matches will be displayed, can be used as
the value of X-Response-Target. Thus, the API calls can be
separated according to the target URL.
type: string
name: x-response-target
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SimilarJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend/profile/{profile_id}/profiles:
post:
tags:
- Recommend
summary: Recommend profiles for a given profile.
operationId: Recommend_profilesForProfile
security:
- JWTBearer: []
description: Recommend profiles for a given profile.
parameters:
- required: true
schema:
title: Profile Id
type: string
name: profile_id
in: path
- description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example, if
TalentAPI is called within a web application, then, the URL of the
page on which the matches will be displayed, can be used as the
value of X-Response-Target. Thus, the API calls can be separated
according to the target URL.
required: false
schema:
title: X-Response-Target
description: >-
An identifier for the usage of the response matches. In this way,
the different use cases can be analyzed separately. For example,
if TalentAPI is called within a web application, then, the URL of
the page on which the matches will be displayed, can be used as
the value of X-Response-Target. Thus, the API calls can be
separated according to the target URL.
type: string
name: x-response-target
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatchConfig'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SimilarProfileResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/recommend/available-matchers:
get:
tags:
- Recommend
summary: Get the recommendation matchers for a given client.
operationId: Recommend_clientMatchersGet
security:
- JWTBearer: []
description: Get the recommendation models for a given client.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecommendClientMatchersGetResponse'
/search/profiles:
post:
tags:
- Search
summary: Find profiles for the given query.
operationId: Search_profilesPost
security:
- JWTBearer: []
description: Find profiles for the given query.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchModel'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchProfileResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/search/jobs:
post:
tags:
- Search
summary: Find jobs for the given query.
operationId: Search_jobsForQueryPost
security:
- JWTBearer: []
description: Find jobs for the given query.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchModel'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/search/jobs/v2:
post:
tags:
- Search
summary: Find jobs for the given query (V2).
operationId: Search_jobsForQueryPostV2
security:
- JWTBearer: []
description: >-
Find jobs for the given query. This endpoint is used for the new job
search.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchModel'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/search/titles:
post:
tags:
- Search
summary: Find job titles for the given query.
operationId: Search_jobTitlesPost
security:
- JWTBearer: []
description: Find job titles for the given query.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobTitleSearchModel'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchJobTitleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/search/jobs/semantic:
post:
tags:
- Search
summary: Find jobs for the given query (Semantic-experimental).
operationId: Search_semanticJobsPost
security:
- JWTBearer: []
description: >-
Find jobs for the given query. This endpoint is used for the semantic
job search.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchModel'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/status:
get:
tags:
- Status
summary: Get global status
operationId: Status_getGlobalData
security:
- JWTBearer: []
description: 'Get your status: numbers and statistics about the data you sent us.'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GlobalStatus'
/skills/feedback:
post:
tags:
- Skills
summary: Add or remove a skill.
operationId: Skills_manageSkill
security:
- JWTBearer: []
description: >-
Add or remove a skill. The job or the profile you refer to must have
been uploaded before.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SkillFeedback'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SkillsManageSkillResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/jobs:
post:
tags:
- Add or Update
summary: Add or update a job.
operationId: AddOrUpdate_jobRecommendations
security:
- JWTBearer: []
description: >-
Add or update a job. Recommendations will be updated shortly to reflect
these changes.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AddOrUpdateJobRecommendationsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/profiles:
post:
tags:
- Add or Update
summary: Add or update a profile.
operationId: AddOrUpdate_profileData
security:
- JWTBearer: []
description: >-
Add or update a profile. Recommendations will be updated shortly to
reflect these changes.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AddOrUpdateProfileDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/matches:
post:
tags:
- Add or Update
summary: Add a match indicator.
operationId: AddOrUpdate_matchIndicator
security:
- JWTBearer: []
description: >-
Add a match indicator. The job and the profile you refer to must have
been uploaded before.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Match'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AddOrUpdateMatchIndicatorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/jobs/{job_id}:
get:
tags:
- Fetch
summary: Fetch a specific job.
operationId: Fetch_specificJob
security:
- JWTBearer: []
description: Fetch a specific job.
parameters:
- required: true
schema:
title: Job Id
type: string
name: job_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DBJob'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Delete
summary: Delete a job.
operationId: Delete_jobById
security:
- JWTBearer: []
description: Delete a job.
parameters:
- required: true
schema:
title: Job Id
type: string
name: job_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteJobByIdResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/profiles/{profile_id}:
get:
tags:
- Fetch
summary: Fetch a specific profile.
operationId: Fetch_specificProfile
security:
- JWTBearer: []
description: Fetch a specific profile.
parameters:
- required: true
schema:
title: Profile Id
type: string
name: profile_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema: