# Respond to AI clarification

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/adapter-scripts/jobs/job-id/respond/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/adapter-scripts/jobs/job-id/respond/llms-full.txt.

POST http://localhost:8080/api/v1/adapter-scripts/jobs/{jobId}/respond
Content-Type: application/json

When a job has status `needs_clarification`, the AI is asking a question.
Send a human response to resume the generation pipeline.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/adapter-scripts/jobs/job-id/respond/respond-to-ai-clarification

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/adapter-scripts/jobs/{jobId}/respond:
    post:
      operationId: respond-to-ai-clarification
      summary: Respond to AI clarification
      description: >
        When a job has status `needs_clarification`, the AI is asking a
        question.

        Send a human response to resume the generation pipeline.
      tags:
        - >-
          subpackage_api.subpackage_api/v1.subpackage_api/v1/adapterScripts.subpackage_api/v1/adapterScripts/jobs.subpackage_api/v1/adapterScripts/jobs/jobId.subpackage_api/v1/adapterScripts/jobs/jobId/respond
      parameters:
        - name: jobId
          in: path
          description: Generation job ID
          required: true
          schema:
            type: string
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_adapter-scripts_jobs_{jobId}_respond_Respond
                  to AI clarification_Response_200
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1Adapter-scriptsJobsJobidRespondRequestBadRequestError
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1Adapter-scriptsJobsJobidRespondRequestNotFoundError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                response:
                  type: string
              required:
                - response
servers:
  - url: http://localhost:8080
components:
  schemas:
    api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_Response_200:
      type: object
      properties:
        code:
          type: integer
        isSuccess:
          type: boolean
        message:
          type: string
      required:
        - code
        - isSuccess
        - message
      title: >-
        api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI
        clarification_Response_200
    ApiV1AdapterScriptsJobsJobIdRespondPostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: >-
        ApiV1AdapterScriptsJobsJobIdRespondPostResponsesContentApplicationJsonSchemaError
    PostApiV1Adapter-scriptsJobsJobidRespondRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1AdapterScriptsJobsJobIdRespondPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1Adapter-scriptsJobsJobidRespondRequestBadRequestError
    PostApiV1Adapter-scriptsJobsJobidRespondRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1AdapterScriptsJobsJobIdRespondPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1Adapter-scriptsJobsJobidRespondRequestNotFoundError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
import requests

url = "http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond"

payload = { "response": "string" }
headers = {
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
const url = 'http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond';
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"response":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond"

	payload := strings.NewReader("{\n  \"response\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"response\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"response\": \"string\"\n}")
  .asString();
```

```php api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond', [
  'body' => '{
  "response": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"response\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift api_v1_adapter-scripts_jobs_{jobId}_respond_Respond to AI clarification_example
import Foundation

let headers = [
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["response": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/adapter-scripts/jobs/5719/respond")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```