API의 개요
On this page
Curriculo API는 https://api.curriculo.me/public 에서 RESTful API로 Curriculo 제품 내부에서 실행되는 동일한 레전트, 평가, 언어 및 인터뷰 엔진에 프로그래밍 액세스 권한을 제공합니다. 요청은 JSON 또는 multipart/form-data입니다. 응답은 JSON입니다.
Curriculo에 새로 왔어? Quickstart: 계정을 생성하고 키를 발급하고 한 번의 전화를 걸기 시작하세요.
전제 조건
- 개발자 콘솔 계정
- 콘솔 → API 키에서 생성된 API 키
사용 가능한 API
| API | 운용 | 그 역할은 | 가격 |
|---|---|---|---|
| 파스 | POST /parse/ | CV (PDF 또는 DOCX) 를 구조화된 JSON로 읽으십시오. | 요청당 $0.01 |
| 평가 | POST /evaluate/ | 직업에 대한 CV를 점수: 적합성, 적합성 분석, 격차. | 요청에 따라 $0.01 |
| 일자리 | POST /jobs/ | 선택적으로요 직무 설명서를 한 번 등록하고 재사용 job_id. | 무료 |
| 번역 | POST /translate/ | 문자열이나 PDF 및 DOCX 문서를 번역합니다. | 요청당 $0.01 ( 가격 참조)) |
| 언어 탐지 | POST /detect-language/ | ISO 639-1 코드는 하나의 텍스트 또는 최대 200 | 요청당 $0.001 |
| 인터뷰 요약 | POST /summary/ | 주요 사항, 적색 플래그, 기술 및 기록 또는 녹음에서 고용 추천 | $0.01, + $0.002 분당 녹음 |
| 번역 | POST /transcribe/ | 녹음 기록이 없고 요약이 없습니다. | 분당 $0.002 |
| 즉시 | POST /prompt/ | 자기소개서를 생성, 편집, 번역 또는 의문을 제기하여 자격증에 붙입니다. 정교하게 | 요청당 $0.01 |
| 스크리닝 인터뷰 | POST /screening-interview | 호스트, 서명된 콜백으로 녹음된 스크리닝 인터뷰 | 발송된 초청당 $0.02 |
배경 작업
분석, 평가, 요약, 번역 및 번역 또한 배경에서 실행됩니다. POST /{op}/async 는 202 에 task_id 로 동시에 응답하고, 당신은 GET /{op}/tasks/{task_id} 로 결과를 수집하거나 서명된 콜백으로 수신합니다. 백그라운드 처리 및 콜백을 참조.
경로
시크로노 동작은 후속 슬래시 (/parse/). 배경 작업 경로 (/parse/async,/parse/tasks/{task_id}) 와 스크리닝 경로 (/screening-interview) 는 하나 없이 문서화된다.
완전한 사양을 위해 OpenAPI 문서를 참조하십시오., 또는 Swagger UI 또는 ReDoc에서 탐색하십시오..
인증
| 헤더 | 가치 | 필요성 |
|---|---|---|
Authorization | Bearer key_<id>_<secret>, 콘솔 API 키 | 그래 |
Content-Type | application/json 또는 multipart/form-data, 동작에 따라 | 네, 시체와 함께 요청할 때 |
한 콘솔 키가 모든 작업을 즉시 승인합니다. 엔드포인트별 자격증도 없고, 범위도 없고, 아무것도 허용할 수 없습니다. 인증 참조.
API 버전 헤더는 없습니다. 표면은 경로에 따라 버전되어 있으며, 추가 변경 (새로운 선택적 필드, 새로운 동작) 는 기존 호출을 끊지 않고 배포됩니다.
기본 URL
https://api.curriculo.me/public그 기지에 클라이언트를 가리키고 작업 경로를 첨부하십시오. https://api.curriculo.me/public/parse/.
- 모든 곳에서 한 개의 자격증 하나의 콘솔 키가 모든 동작을 인증합니다.
- 키마다 제한이 적용되는데, 그래서 한 험난한 통합은 다른 사람의 예산을 쓸 수 없습니다.
- 실패한 요청은 결코 청구되지 않습니다. A
4xx또는5xx는 당신에게 아무것도 걸리지 않습니다.
생산은 유일한 출판 환경입니다.
요청 및 응답 형식
요청 및 응답참조 짧은 버전:
/parse/,/evaluate/,/prompt/그리고/transcribe/복용multipart/form-data./detect-language/그리고/jobs/복용application/json./translate//summary/는application/json또는multipart/form-data를 사용하여 문서나 녹음을 전송합니다.- 한 문서가 최대 10 MB이 될 수 있습니다. 요청 기관은
/summary/를 제외하고는 최대 12 MB이 될 수 있으며, 100 MB까지 녹음을 수용합니다. - 하나의 물건 보내서 그 물건의 물체를 가져오세요. 몇 개를 보내서, 입력 순서대로 결과를 얻으세요.
배팅
별도의 배트 최종점은 없습니다. 목록은 배트입니다. 분석 및 평가에 대한 요청에 따라 최대 10개의 문서, 번역 및 언어 검출을 위한 최대 200개의 텍스트. 배팅 참조.
환율 제한
| 제한 | 가치 |
|---|---|
| 각 API 키 | 초당 600개의 요청 |
| IP 주소당 | 1 분당 2천 건의 요청 |
| 무거운 작업 (분석, 평가, 요약) | 서비스에서 공유되는 한 번에 3개의 작업; 추가 요청 순차 |
| 시간 제한 요청 | 300초 |
오류
오류는 JSON이고 중요한 HTTP 상태를 가지고 있습니다. 모든 응답에는 X-Curriculo-Request-Id 헤더가 포함되어 있습니다. 오류 참조.
계좌 관리
키, 사용 및 청구는 개발자 콘솔에서 관리됩니다. 당신의 API 키는 고용 작업입니다. 의도적으로 열쇠를 만들거나 청구서를 변경할 수 없으므로 유출된 열쇠는 절대 계좌 통제로 올라갈 수 없습니다.
다음 단계
- Quickstart: 계정, 키, 첫 번째 호출 3 단계
- 백그라운드 처리 및 콜백: 연결을 열어 놓지 않고 긴 작업.
- 클라이언트 SDK: OpenAPI 스펙에서 입력된 클라이언트를 생성합니다.
- API 참조: 모든 작업에 대한 모든 필드.
Updated