Skip to content
NimlesNimlesNimles Docs

Send a stateless chat message to an agent

POST
/api/tenant/{tenantId}/Agents/{agentId}/chat
curl --request POST \
  --url https://api.nimles.com/ai/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Agents/example/chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "message": "example", "history": [ { "role": "example", "content": "example" } ], "context": { "additionalProperty": "example" } }'

Sends a stateless chat message to an agent.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agentId
required
string

The agent slug identifier.

tenantId
required
string format: uuid

Your tenant id.

Request Body

Section titled “Request Body”

The chat request.

Media typeapplication/json
object
message
string
nullable
history
Array<object>
nullable
object
role
string
nullable
content
string
nullable
context
object
key
additional properties

Example generated

{
  "message": "example",
  "history": [
    {
      "role": "example",
      "content": "example"
    }
  ],
  "context": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
message
string
nullable
suggestedActions
Array<object>
nullable
object
type
string
nullable
label
string
nullable
data
nullable
toolCalls
Array<object>
nullable
object
id
string
nullable
name
string
nullable
arguments
object
key
additional properties
nullable
usage
object
inputTokens
integer format: int32
nullable
outputTokens
integer format: int32
nullable
totalTokens
integer format: int32
nullable
metadata
object
key
additional properties

Example generated

{
  "message": "example",
  "suggestedActions": [
    {
      "type": "example",
      "label": "example",
      "data": "example"
    }
  ],
  "toolCalls": [
    {
      "id": "example",
      "name": "example",
      "arguments": {
        "additionalProperty": "example"
      }
    }
  ],
  "usage": {
    "inputTokens": 1,
    "outputTokens": 1,
    "totalTokens": 1
  },
  "metadata": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Section titled “422”

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}