Skip to main content
POST
/
v1
/
apis
/
{api_id}
/
respond
Provide additional input for a paused API build
curl --request POST \
  --url https://api.peel.sh/v1/apis/{api_id}/respond \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "response": {},
  "wait_for_completion": false,
  "timeout_ms": 60500
}
'
{
  "api": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "instructions": "<string>",
    "name": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "endpoint_count": 123,
    "failure": {
      "artifact": {
        "attempted_strategies": [
          "<string>"
        ],
        "blocked_policy": "<string>",
        "evidence_refs": [
          "<string>"
        ],
        "schema_version": 1,
        "stage": "<string>",
        "support_debug_id": "<string>",
        "technical_reason": "<string>",
        "user_facing_reason": "<string>",
        "diagnostic_context": {
          "action_flow_research": {
            "action_kind": "<string>",
            "candidate_count": 1,
            "deterministic_runtime_required": true,
            "explicit_user_call_required": true,
            "no_replayable_sequence_reason": "<string>",
            "policy_blockers": [
              "<string>"
            ],
            "policy_check_status": "<string>",
            "publication_gate": "<string>",
            "replayable_evidence_required": true,
            "request_sequence_count": 1,
            "request_sequences": [
              {
                "evidence_ref": "<string>",
                "fields": [
                  "<string>"
                ],
                "method": "<string>",
                "requires_csrf": true,
                "requires_session": true,
                "source": "<string>",
                "status": 123,
                "step_kind": "<string>",
                "url_pattern": "<string>"
              }
            ],
            "requires_csrf": true,
            "requires_session": true,
            "runtime_transport": "<string>",
            "sequence_evidence_status": "<string>",
            "side_effect_class": "<string>",
            "user_intent_required": true
          }
        }
      },
      "code": "<string>",
      "message": "<string>",
      "refund_reviewable": true,
      "retryable": true
    },
    "failure_reason_code": "<string>",
    "links": {},
    "description": "<string>",
    "source_url": "<string>",
    "error": "<string>",
    "auth_mode": "<string>",
    "requires_session": true,
    "user_input_prompt": {},
    "endpoints": [
      {
        "method": "<string>",
        "endpoint_name": "<string>",
        "input_schema": {},
        "output_schema": {},
        "endpoint_type": "<string>",
        "auth_requirement": "<string>",
        "examples": [
          {
            "kind": "<string>",
            "label": "<string>",
            "request": {
              "method": "<string>",
              "path": "<string>",
              "headers": {},
              "body": {
                "params": {},
                "session_id": "<string>",
                "encryption_key": "<string>"
              }
            },
            "mcp_tool_call": {
              "name": "<string>",
              "arguments": {
                "api_id": "<string>",
                "endpoint_name": "<string>",
                "params": {},
                "session_id": "<string>",
                "encryption_key": "<string>"
              }
            },
            "curl": "<string>",
            "cli_command": "<string>"
          }
        ],
        "initiates_session": true,
        "runtime_kind": "<string>",
        "runtime_policy": {
          "allowed_bare_imports": [
            "<string>"
          ],
          "environment_policy": "<string>",
          "filesystem_policy": "<string>",
          "forbidden_capabilities": [
            "<string>"
          ],
          "network_policy": "<string>",
          "policy_schema_version": 123,
          "timeout_ms": 123,
          "action_flow_policy": {
            "action_kind": "<string>",
            "deterministic_runtime": true,
            "evidence_refs": [
              "<string>"
            ],
            "explicit_user_call_required": true,
            "policy_schema_version": 123,
            "replayable_evidence": true,
            "requires_csrf": true,
            "requires_session": true,
            "runtime_transport": "<string>",
            "side_effect_class": "<string>",
            "user_intent_required": true
          }
        },
        "runtime_strategy": "<string>",
        "runtime_verification": {
          "field_coverage": 123,
          "item_count": 123,
          "low_quality_fields": [
            "<string>"
          ],
          "missing_fields": [
            "<string>"
          ],
          "observed_fields": [
            "<string>"
          ],
          "reason": "<string>",
          "status": "<string>"
        },
        "description": "<string>",
        "credit_cost": 123,
        "depends_on_session": "<string>",
        "session_tag": "<string>"
      }
    ],
    "binding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identity": {
      "api_id": "<string>",
      "binding_id": "<string>",
      "version_id": "<string>"
    }
  },
  "response_queued": true,
  "waited": true,
  "timed_out": true
}

Authorizations

X-API-Key
string
header
required

Path Parameters

api_id
string<uuid>
required

Body

application/json
response
object
required
wait_for_completion
boolean
default:false
timeout_ms
integer
Required range: 1000 <= x <= 120000

Response

Paused build resumed.

api
object
required
response_queued
boolean
required
waited
boolean
required
timed_out
boolean
required