Debriefer

Record participant consent

Records participant consent decision. Run must be in awaiting_consent status. If granted, transitions to active. If declined, transitions to completed.

POST
/api/v1/interview-runs/{id}/consent

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

granted*boolean

Response Body

application/json

curl -X POST "https://loading/api/v1/interview-runs/run_1234567890abcdef/consent" \  -H "Content-Type: application/json" \  -d '{    "granted": true  }'
{
  "id": "string",
  "organization_id": "string",
  "test_mode": true,
  "blueprint_id": "string",
  "blueprint_version": -2147483648,
  "agent_id": "string",
  "channel_id": "string",
  "connector_id": "string",
  "meeting_url": "string",
  "dial_in_pin": "string",
  "status": "created",
  "consent_status": "pending",
  "participant": {
    "external_id": "string",
    "name": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  },
  "join_url": "string",
  "join_token": "string",
  "expires_at": "string",
  "scheduled_at": "string",
  "progress": {
    "nodes_total": 0,
    "nodes_visited": 0,
    "current_node": "string",
    "path_taken": [
      "string"
    ],
    "duration_s": 0,
    "estimated_remaining_s": 0
  },
  "current_session_id": "string",
  "session_count": -2147483648,
  "transcript_id": "string",
  "responses_id": "string",
  "analysis_id": "string",
  "started_at": "string",
  "completed_at": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "object": "interview_run",
  "blueprint": {
    "id": "string",
    "organization_id": "string",
    "test_mode": true,
    "agent_id": "string",
    "name": "string",
    "description": "string",
    "version": -2147483648,
    "status": "draft",
    "graph": {
      "entry_node": "string",
      "nodes": {
        "property1": {
          "type": "question",
          "key": "string",
          "text": "string",
          "objective": "string",
          "required": true,
          "probing": {
            "enabled": true,
            "max_follow_ups": 0,
            "techniques": [
              "string"
            ],
            "completion_hint": "string"
          }
        },
        "property2": {
          "type": "question",
          "key": "string",
          "text": "string",
          "objective": "string",
          "required": true,
          "probing": {
            "enabled": true,
            "max_follow_ups": 0,
            "techniques": [
              "string"
            ],
            "completion_hint": "string"
          }
        }
      },
      "edges": [
        {
          "from": "string",
          "to": "string",
          "condition": {
            "type": "structured",
            "field": "string",
            "operator": "eq",
            "value": null
          },
          "priority": 0
        }
      ]
    },
    "settings": {
      "estimated_duration_m": 1,
      "max_duration_m": 1,
      "intro_message": "string",
      "outro_message": "string",
      "language": "string",
      "consent": true
    },
    "pipeline": {
      "transcript": true,
      "responses": true,
      "analysis": true
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "published_at": "string",
    "created_at": "string",
    "updated_at": "string",
    "object": "blueprint",
    "agent": {
      "id": "string",
      "organization_id": "string",
      "test_mode": true,
      "name": "string",
      "description": "string",
      "persona": {
        "system_prompt": "string",
        "tone": "conversational",
        "language": "string"
      },
      "voice": {
        "provider": "string",
        "voice_id": "string",
        "speed": 0.5
      },
      "techniques": [
        "funnel"
      ],
      "probing_depth": "light",
      "boundaries": {
        "max_follow_ups_per_question": 0,
        "off_topic_handling": "gentle_redirect",
        "sensitive_topics": [
          "string"
        ]
      },
      "model_config": {
        "generation": {
          "provider": "anthropic",
          "model": "string"
        },
        "assessment": {
          "provider": "anthropic",
          "model": "string"
        }
      },
      "metadata": {
        "property1": null,
        "property2": null
      },
      "created_at": "string",
      "updated_at": "string",
      "object": "agent"
    }
  },
  "agent": {
    "id": "string",
    "organization_id": "string",
    "test_mode": true,
    "name": "string",
    "description": "string",
    "persona": {
      "system_prompt": "string",
      "tone": "conversational",
      "language": "string"
    },
    "voice": {
      "provider": "string",
      "voice_id": "string",
      "speed": 0.5
    },
    "techniques": [
      "funnel"
    ],
    "probing_depth": "light",
    "boundaries": {
      "max_follow_ups_per_question": 0,
      "off_topic_handling": "gentle_redirect",
      "sensitive_topics": [
        "string"
      ]
    },
    "model_config": {
      "generation": {
        "provider": "anthropic",
        "model": "string"
      },
      "assessment": {
        "provider": "anthropic",
        "model": "string"
      }
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "created_at": "string",
    "updated_at": "string",
    "object": "agent"
  },
  "channel": {
    "id": "string",
    "organization_id": "string",
    "test_mode": true,
    "name": "string",
    "type": "webrtc_voice",
    "status": "active",
    "provider": {
      "name": "string",
      "credentials_id": "string",
      "config": {
        "property1": null,
        "property2": null
      }
    },
    "settings": {
      "recording": true,
      "max_duration_s": 1,
      "idle_timeout_s": 1
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "created_at": "string",
    "updated_at": "string",
    "object": "channel"
  },
  "connector": {
    "id": "string",
    "organization_id": "string",
    "test_mode": true,
    "name": "string",
    "type": "google_meet",
    "status": "active",
    "auth": {
      "credentials_id": "string",
      "service_account": "string"
    },
    "bot_config": {
      "display_name": "string",
      "avatar_url": "http://example.com",
      "join_message": "string",
      "auto_record": true
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "created_at": "string",
    "updated_at": "string",
    "object": "connector"
  },
  "transcript": {
    "id": "string",
    "run_id": "string",
    "organization_id": "string",
    "test_mode": true,
    "status": "pending",
    "entries": [
      {
        "id": "string",
        "role": "agent",
        "content": "string",
        "timestamp": "string",
        "duration_ms": 0,
        "session_id": "string",
        "node_id": "string",
        "question_key": "string",
        "entry_type": "utterance",
        "confidence": 0
      }
    ],
    "word_count": -2147483648,
    "duration_s": -2147483648,
    "language": "string",
    "created_at": "string",
    "updated_at": "string",
    "object": "transcript"
  },
  "responses": {
    "id": "string",
    "run_id": "string",
    "organization_id": "string",
    "test_mode": true,
    "status": "pending",
    "items": [
      {
        "node_id": "string",
        "question_key": "string",
        "question_text": "string",
        "answered": true,
        "answer": {
          "summary": "string",
          "verbatim": "string",
          "transcript_entry_ids": [
            "string"
          ]
        },
        "follow_ups_asked": 0,
        "probing_complete": true,
        "node_type": "question"
      }
    ],
    "path_taken": [
      "string"
    ],
    "completion_rate": -8388608,
    "created_at": "string",
    "updated_at": "string",
    "object": "response"
  },
  "analysis": {
    "id": "string",
    "run_id": "string",
    "organization_id": "string",
    "test_mode": true,
    "status": "pending",
    "results": {
      "summary": {
        "content": "string",
        "word_count": 0
      },
      "themes": {
        "items": [
          {
            "label": "string",
            "salience": 0,
            "evidence_count": 0
          }
        ]
      },
      "sentiment": {
        "overall": "positive",
        "by_question": [
          {
            "question_key": "string",
            "sentiment": "positive"
          }
        ]
      }
    },
    "model": "string",
    "created_at": "string",
    "updated_at": "string",
    "object": "analysis"
  }
}
Empty
Empty

Cancel an interview run

Previous Page

Send a message to an active interview

Next Page