Skip to main content
POST

Authorizations

X-DOMO-Developer-Token
string
header
required

Body

application/json

Request for making tool calls using AI.

input
object[]

The list of input messages to be processed by the AI.

sessionId
string<uuid>

The unique identifier for the AI session associated with this request.

system
object[]

System-level messages or configurations to guide the AI's response.

model
string

The identifier of the AI model to be used for generating a response.

modelConfiguration
object

Specific parameters or settings that configure the AI model behavior.

temperature
number<double>

A parameter for controlling the randomness of the model's output.

maxTokens
integer<int32>

The maximum number of tokens to generate in the response.

tools
object[]

The list of tools the model can call.

toolChoice
object

How the model should use the provided tools.

validateSchema
boolean

A flag to determine whether to validate the AI response against the provided schema.

reasoningConfig
object

Configuration for reasoning behavior and effort level.

Response

Successful tool calling response.

Response from a Messages API.

content
object[]

The list of content generated by the model.

Text-based message content.

modelId
string

The id of the model used to generate the response.

sessionId
string<uuid>

The id of the AI Session associated with this request.

stopReason
enum<string>

The reason that the model stopped.

Available options:
TOOL_USE,
MAX_TOKENS,
STOP_SEQUENCE,
END_TURN,
CONTENT_FILTERED,
SAFETY,
UNKNOWN
modelProviderUsage
object

The token usage from the model provider.