Close

Close a session and receive the response as a NDJSON stream

See Parsing NDJSON stream for an example on how to parse the response stream.

post

Authorizations

Body

businessIdstringOptional

clientKeystringOptional

sessionIdstringOptional

Responses

200

A successful response.(streaming responses)

application/json

default

An unexpected error response.

application/json

post

HTTPcURLJavaScriptPython

POST /external/v1/ai/agent_graph/close HTTP/1.1
Host: api.connectly.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "businessId": "text",
  "clientKey": "text",
  "sessionId": "text"
}

{
  "result": {
    "response": {}
  },
  "error": {
    "code": 1,
    "message": "text",
    "details": [
      {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  }
}