S2S Conversations

Answer workflow step

Answer the pending workflow step (text, selection, rating, attachments) or request a human with botAction "humanHandoff".

POST

https://api.gleap.io/v3/s2s/conversations/{conversationId}/workflow/answer

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

conversationIdstringrequired

Headers

Gleap-Versionstring

Pin a specific API version; defaults to the current version.

Example: 2026-08-01

Idempotency-Keystring

Makes the POST retryable: a completed successful response replays for 24 hours (Gleap-Idempotency-Replayed: true). Semantics are at-least-once — a retry that races a crashed or >60s-running original may re-execute. Error responses are never stored; retry them normally.

max length 255

Bodyapplication/jsonrequired

textstring

Free-text answer (input / chat steps).

selectedstring

Selected option value (button / select steps).

ratingnumber<double>

Rating value (rate-conversation steps).

attachmentsobject[]

Show child attributes

urlstringrequired

namestring

contentTypestring

botActionenum<string>

"humanHandoff" requests a human without waking an agent run.

Allowed values: humanHandoff

Response

Accepted

application/problem+json

Missing, invalid or revoked service account token.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

The addressed resource does not exist in this project.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Idempotency-Key reuse with a different request body.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Rate limit exceeded — honor the Retry-After header.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Any other error, including validation_failed (400) and internal_error (500).

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

Updated November 1, 2026

curl --request POST \
  --url 'https://api.gleap.io/v3/s2s/conversations/{conversationId}/workflow/answer' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "botAction": "humanHandoff"
}'

No example in the spec.

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

Headers

Gleap-Versionstring

Pin a specific API version; defaults to the current version.

Example: 2026-08-01

Idempotency-Keystring

max length 255

Bodyapplication/jsonrequired

textstring

Free-text answer (input / chat steps).

selectedstring

Selected option value (button / select steps).

ratingnumber<double>

Rating value (rate-conversation steps).

attachmentsobject[]

Show child attributes

urlstringrequired

namestring

contentTypestring

botActionenum<string>

"humanHandoff" requests a human without waking an agent run.

Allowed values: humanHandoff

Response

Accepted

application/problem+json

Missing, invalid or revoked service account token.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

The addressed resource does not exist in this project.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Idempotency-Key reuse with a different request body.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Rate limit exceeded — honor the Retry-After header.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Any other error, including validation_failed (400) and internal_error (500).

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

curl --request POST \ --url 'https://api.gleap.io/v3/s2s/conversations/{conversationId}/workflow/answer' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "botAction": "humanHandoff" }'

{ "type": "https://docs.gleap.io/s2s/problems/conversation_closed", "title": "string", "status": 0, "code": "conversation_closed", "detail": "string", "request_id": "req_66c0ffee0000000000000001" }