> ## Documentation Index > Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt > Use this file to discover all available pages before exploring further. # AI 증명사진 Task API의 연동 및 사용 > AI ID Photo Production 集成指南 - XHuoAPI AI 증명사진 Task API의 주요 기능은 AI 증명사진 제작 API로부터 생성된 작업 ID를 입력하여 해당 작업의 실행 상태를 조회하는 것입니다. 본 문서는 AI 증명사진 Task API의 연동 설명을 자세히 소개하여, 귀하가 쉽게 통합하고 해당 API의 강력한 기능을 충분히 활용할 수 있도록 돕습니다. AI 증명사진 Task API를 통해 AI 증명사진 제작 API의 작업 실행 상태를 쉽게 조회할 수 있습니다. ## 신청 절차 AI 증명사진 Task API를 사용하려면 먼저 신청 페이지 [AI 증명사진 제작 API](https://api.xhuoapi.ai/documents/bf7214a3-8447-4157-8a75-f5bb39d5ed1b)에서 해당 서비스를 신청한 후, AI 증명사진 제작 API의 작업 ID를 복사해야 합니다. 아래 그림과 같이 진행합니다:

마지막으로 Tasks API 페이지 [AI 증명사진 Task API](https://api.xhuoapi.ai/documents/3a23ee34-8689-406b-9042-7954224348ad)에서 해당 서비스를 신청하고, 페이지에 들어가면 「Acquire」 버튼을 클릭합니다. 아래 그림과 같이 진행합니다: ![신청 페이지](https://cdn.xhuoapi.ai/rci31i.png) 로그인 또는 등록이 되어 있지 않은 경우, 자동으로 [로그인 페이지](https://api.xhuoapi.ai)로 이동하여 등록 및 로그인을 요청합니다. 로그인 및 등록 후에는 자동으로 현재 페이지로 돌아옵니다. 첫 신청 시 무료 사용 한도가 제공되어, 해당 API를 무료로 사용할 수 있습니다. ## 요청 예시 AI 증명사진 Task API는 AI 증명사진 제작 API의 결과를 조회하는 데 사용할 수 있습니다. AI 증명사진 제작 API 사용 방법에 대한 자세한 내용은 문서 [AI 증명사진 제작 API](https://api.xhuoapi.ai/documents/d6ea75a4-836e-490a-aee5-7ca911a808fd)를 참조하십시오. AI 증명사진 제작 API 서비스에서 반환된 작업 ID를 예로 들어, 해당 API를 사용하는 방법을 시연합니다. 가정해 보겠습니다, 작업 ID가 `16f96e95-d95c-46ef-b183-139b9bd1aebd`라고 할 때, 다음과 같이 작업 ID를 전달하여 진행합니다. ### 작업 예시 그림

### 요청 헤더 및 요청 본문 설정 **Request Headers**에는 다음이 포함됩니다: * `accept`: JSON 형식의 응답 결과를 수신하도록 지정하며, 여기서는 `application/json`으로 설정합니다. * `authorization`: API 호출에 필요한 키로, 신청 후 직접 드롭다운에서 선택할 수 있습니다. **Request Body**에는 다음이 포함됩니다: * `id`: 업로드된 작업 ID. * `action`: 작업의 조작 방식. 아래 그림과 같이 설정합니다:

### 코드 예시 페이지 오른쪽에서 다양한 언어의 코드가 자동으로 생성된 것을 확인할 수 있습니다. 아래 그림과 같이 진행합니다:

일부 코드 예시는 다음과 같습니다: #### CURL ```bash theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/headshots/tasks' \ -H 'accept: application/json' \ -H 'authorization: Bearer {token}' \ -H 'content-type: application/json' \ -d '{ "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd", "action": "retrieve" }' ``` #### Python ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/headshots/tasks" headers = { "accept": "application/json", "authorization": "Bearer {token}", "content-type": "application/json" } payload = { "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd", "action": "retrieve" } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ### 응답 예시 요청이 성공하면, API는 이곳의 증명사진 작업에 대한 세부 정보를 반환합니다. 예를 들어: ```json theme={null} { "_id": "67276ab6550a4144a53b6036", "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd", "api_id": "53bcc3f7-12ec-4f04-8ca4-20f150dcde2a", "application_id": "1af53f80-c166-4f54-a8ea-0ffc24d8e2cd", "created_at": 1730636470.402, "credential_id": "3c253880-21ef-478a-9389-c09fa837ac7c", "request": { "mode": "relax", "template": "male_portrait", "image_urls": [ "https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg" ], "callback_url": "https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a" }, "trace_id": "6eded0e2-274d-4cde-a567-d6b0decb9a97", "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf", "response": { "success": true, "task_id": "16f96e95-d95c-46ef-b183-139b9bd1aebd", "data": [ { "id": "202411032022077381", "image_url": "https://platform.cdn.xhuoapi.ai/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png", "template": "남성 이미지 사진" }, { "id": "202411032022079194", "image_url": "https://platform.cdn.xhuoapi.ai/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png", "template": "남성 이미지 사진" } ] } } ``` 반환 결과에는 여러 필드가 있으며, request 필드는 작업을 시작할 때의 request body를 나타내고, response 필드는 작업 완료 후 반환된 response body를 나타냅니다. 필드 설명은 다음과 같습니다. * `id`: 이 증명사진 작업을 생성한 ID로, 이번 증명사진 생성 작업을 고유하게 식별하는 데 사용됩니다. * `request`: 증명사진 작업의 요청 정보를 조회합니다. * `response`: 증명사진 작업의 반환 정보를 조회합니다. ## 배치 조회 작업 이는 여러 작업 ID에 대해 증명사진 작업 세부 정보를 조회하는 것으로, 위와 다른 점은 action을 retrieve\_batch로 선택해야 한다는 것입니다. **Request Body**에는 다음이 포함됩니다: * `ids`: 업로드된 작업 ID 배열. * `action`: 작업의 조작 방식. 아래 그림과 같이 설정합니다:

### 코드 예시 페이지 오른쪽에서 다양한 언어의 코드가 자동으로 생성된 것을 확인할 수 있습니다. 아래 그림과 같이 진행합니다:

일부 코드 예시는 다음과 같습니다: ### 응답 예시 요청이 성공하면, API는 이번 모든 배치 증명사진 작업의 구체적인 세부 정보를 반환합니다. 예를 들어: ```json theme={null} { "items": [ { "_id": "67276ab6550a4144a53b6036", "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd", "api_id": "53bcc3f7-12ec-4f04-8ca4-20f150dcde2a", "application_id": "1af53f80-c166-4f54-a8ea-0ffc24d8e2cd", "created_at": 1730636470.402, "credential_id": "3c253880-21ef-478a-9389-c09fa837ac7c", "request": { "mode": "relax", "template": "male_portrait", "image_urls": [ "https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg" ], "callback_url": "https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a" }, "trace_id": "6eded0e2-274d-4cde-a567-d6b0decb9a97", "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf", "response": { "success": true, "task_id": "16f96e95-d95c-46ef-b183-139b9bd1aebd", "data": [ { "id": "202411032022077381", "image_url": "https://platform.cdn.xhuoapi.ai/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png", "template": "남성 초상화" }, { "id": "202411032022079194", "image_url": "https://platform.cdn.xhuoapi.ai/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png", "template": "남성 초상화" } ] } }, { "_id": "67276c52550a4144a53b995b", "id": "5213468b-6b96-4ad4-9c6a-657bd438d299", "api_id": "53bcc3f7-12ec-4f04-8ca4-20f150dcde2a", "application_id": "1af53f80-c166-4f54-a8ea-0ffc24d8e2cd", "created_at": 1730636882.359, "credential_id": "3c253880-21ef-478a-9389-c09fa837ac7c", "request": { "mode": "relax", "template": "male_portrait", "image_urls": [ "https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg" ], "callback_url": "https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a" }, "trace_id": "50b2b4a8-6c1c-4b95-ac0b-46e5b97c7b18", "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf", "response": { "task_id": "5213468b-6b96-4ad4-9c6a-657bd438d299", "status": "unknown", "data": [] } } ], "count": 2 } ``` #### CURL ```bash theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/headshots/tasks' \ -H 'accept: application/json' \ -H 'authorization: Bearer {token}' \ -H 'content-type: application/json' \ -d '{ "ids": ["16f96e95-d95c-46ef-b183-139b9bd1aebd","5213468b-6b96-4ad4-9c6a-657bd438d299"], "action": "retrieve_batch" }' ``` #### Python ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/headshots/tasks" headers = { "accept": "application/json", "authorization": "Bearer {token}", "content-type": "application/json" } payload = { "ids": ["16f96e95-d95c-46ef-b183-139b9bd1aebd","5213468b-6b96-4ad4-9c6a-657bd438d299"], "action": "retrieve_batch" } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## 오류 처리 API를 호출할 때 오류가 발생하면, API는 해당 오류 코드와 정보를 반환합니다. 예를 들어: * `400 token_mismatched`：잘못된 요청, 누락되었거나 잘못된 매개변수로 인한 것일 수 있습니다. * `400 api_not_implemented`：잘못된 요청, 누락되었거나 잘못된 매개변수로 인한 것일 수 있습니다. * `401 invalid_token`：권한 없음, 잘못되었거나 누락된 인증 토큰입니다. * `429 too_many_requests`：요청이 너무 많음, 비율 제한을 초과했습니다. * `500 api_error`：내부 서버 오류, 서버에서 문제가 발생했습니다. ### 오류 응답 예시 ```json theme={null} { "success": false, "error": { "code": "api_error", "message": "fetch failed" }, "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89" } ``` ## 결론 본 문서를 통해 AI 증명사진 Task API를 사용하여 단일 또는 배치 증명사진 작업의 모든 구체적인 세부 정보를 조회하는 방법을 이해하셨습니다. 본 문서가 API를 더 잘 연결하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 기술 지원 팀에 문의해 주십시오.