Skip to main content
POST
Request JSON

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Headers

Idempotency-Key
string
required
Required string length: 1 - 128

Path Parameters

run_id
string<uuid>
required

Run that owns the input request. A fresh creation request without a recorded waiting tool call or tool_call_id, or with a duplicate open run/tool-call request, returns 409. An authorized retry of the identical request with the same idempotency key returns its stored result.

Body

application/json
title
string
required
Required string length: 1 - 1000
fields
object[]
required
Required array length: 1 - 100 elements
tool_call_id
string

Tool invocation to request input for. Defaults to the run’s current waiting invocation.

Required string length: 1 - 128
requested_responder_type
enum<string>
default:human
Available options:
human,
agent,
system
description
string
Maximum string length: 20000
expires_at
string<date-time>
metadata
object

Response

Input request created or idempotently replayed

input_request_id
string<uuid>
required

Unique input request ID.

project_id
string<uuid>
required

Project inherited from the run.

run_id
string<uuid>
required

Run waiting for this input.

title
string
required

Question or decision shown to the responder.

Required string length: 1 - 1000
fields
object[]
required

Fields the responder can fill in.

status
enum<string>
required

Current resolution state.

Available options:
open,
submitted,
cancelled,
expired
requested_responder_type
enum<string>
required

Required responder role; the authenticated actor identifies who actually responded.

Available options:
human,
agent,
system
response
object · null · null
required

Submitted response, or null before submission or after cancellation or expiry.

created_at
string<date-time>
required

When the request was created.

expires_at
string<date-time>

When the request expires.

resolved_at
string<date-time>

When the request was submitted, cancelled or expired.

tool_call_id
string

Tool invocation waiting for the response.

Required string length: 1 - 128
conversation_id
string<uuid>

Conversation inherited from the run.

description
string

Additional instructions for the responder.

metadata
object

Additional resource metadata.