Conversational Form API

This endpoint retrieves data from an organization's specified formless form instance.

Base URL: https://www.stack-inference.com

HTTP Method: GET

Authorization: An authorization header with a valid private key is required to access this endpoint. The key is used for user authentication and to ensure secure data retrieval.

Query Parameters:

Parameter

Type

Description

org

string

Identifier of the organization.

flow_id

string

Unique identifier of the formless form flow within the org.

node_id

string

Unique identifier of the formless form instance (e.g., tool_datacollector-0).

Headers:

Header

Value

Description

Authorization

[YourPrivateKey]

Private key for user authentication.

Sample Request:

GET https://www.stack-inference.com/get_formless_form_api?org=organization123&flow_id=formFlow456&node_id=tool_datacollector-0
Headers:
Authorization: Bearer PrivateKey

Responses:

Success (200 OK):

A list of data points collected from the specified formless form instance:

[
    {
        "dataKey1": "dataValue1",
        "dataKey2": "dataValue2",
        ...
    },
    ...
]

Error (500 Internal Server Error):

In case of an authentication error:

{
    "detail": "Authentication error"
}

Notes:

  • The private key in the authorization header should be kept confidential to ensure data privacy and security.

Last updated