Skip to main content
POST
/
conversations
/
{conversation_id}
/
input-requests
Create a durable input request for a conversation
curl --request POST \
  --url https://api.veryfront.com/conversations/{conversation_id}/input-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "<string>",
  "tool_call_id": "<string>",
  "title": "<string>",
  "fields": [
    {}
  ],
  "kind": "form",
  "description": "<string>",
  "recommendations": {},
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_id": "<string>",
  "tool_call_id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "fields": [
    {}
  ],
  "recommendations": {},
  "metadata": {},
  "created_at": "<string>",
  "expires_at": "<string>",
  "submitted_at": "<string>",
  "cancelled_at": "<string>",
  "expired_at": "<string>",
  "latest_response": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_id": "<string>",
    "actor_id": "<string>",
    "values": {},
    "created_at": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
conversation_id
string<uuid>
required

Body

application/json
​
run_id
string
required
Required string length: 1 - 255
​
tool_call_id
string
required
Required string length: 1 - 255
​
requested_responder_type
enum<string>
required
Available options:
human,
agent,
system
​
title
string
required
Required string length: 1 - 1000
​
fields
object[]
required
Required array length: 1 - 100 elements
​
kind
enum<string>
default:form
Available options:
form
​
description
string
Required string length: 1 - 20000
​
recommendations
object
​
expires_at
string<date-time>
​
metadata
object

Response

Created input request

​
id
string<uuid>
required
​
conversation_id
string<uuid>
required
​
run_id
string
required
​
tool_call_id
string
required
​
kind
enum<string>
required
Available options:
form
​
status
enum<string>
required
Available options:
open,
submitted,
cancelled,
expired
​
requested_responder_type
enum<string>
required
Available options:
human,
agent,
system
​
title
string
required
​
description
string | null
required
​
fields
object[]
required
​
recommendations
object
required
​
metadata
object
required
​
created_at
string
required
​
expires_at
string | null
required
​
submitted_at
string | null
required
​
cancelled_at
string | null
required
​
expired_at
string | null
required
​
latest_response
object