App Builder

Query App

Post a completion request to the ai model given an app id and set of inputs.

Inputs are usually in the form of JSON object like:

{'<variable_name>': '<value>'}

Example: {'name': 'John', 'age': 25}

The variable name should be the same as the variable name in the app.

Returns:

- StreamingResponse when request.stream=True

- CompletionResponse when request.stream=False
post/app/{app_id}/query

Request

  • Base URL: https://ai.hatz.ai/v1
  • URL: https://ai.hatz.ai/v1/app/{app_id}/query
  • Auth: API key in header X-API-Key

Path parameters

app_idstring uuid required

The unique identifier of the app to query

Request body

inputsobject required

The list of inputs on the app to process. Usually in the form of JSON object like {'<variable_name>': '<value>'}. The variable name should be the same as the variable name in the app.

modelstring nullable

The AI model to use for processing. Please use the unique name of the model, not the display name

streamboolean

Whether to stream the response

file_uuidsstring[] nullable

The list of file uuids to process

Response

Successful Response

OR

Changes

No recorded changes to this operation across all 1 revision of this API.