Get AI suggestions from an agent
POST
/api/tenant/{tenantId}/Agents/{agentId}/suggestions
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.nimles.com/ai/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Agents/example/suggestions"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"suggestionType\": \"example\", \"count\": 1, \"context\": { \"additionalProperty\": \"example\" }, \"promptTemplate\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.nimles.com/ai/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Agents/example/suggestions';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"suggestionType":"example","count":1,"context":{"additionalProperty":"example"},"promptTemplate":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.nimles.com/ai/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Agents/example/suggestions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "suggestionType": "example", "count": 1, "context": { "additionalProperty": "example" }, "promptTemplate": "example" }'Gets AI suggestions from 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 suggestions request.
Media typeapplication/json
object
suggestionType
string
count
integer format: int32
context
object
key
additional properties
promptTemplate
string
Example generated
{ "suggestionType": "example", "count": 1, "context": { "additionalProperty": "example" }, "promptTemplate": "example"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
suggestions
Array<object>
object
title
string
description
string
reasoning
string
metadata
object
key
additional properties
usage
object
inputTokens
integer format: int32
outputTokens
integer format: int32
totalTokens
integer format: int32
Example generated
{ "suggestions": [ { "title": "example", "description": "example", "reasoning": "example", "metadata": { "additionalProperty": "example" } } ], "usage": { "inputTokens": 1, "outputTokens": 1, "totalTokens": 1 }}Unauthorized: no bearer token, or one that is expired or not for this API.
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
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not found: no such item in the tenant.
Media typeapplication/problem+json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Conflict: the item kept changing under concurrent writes; read it again and retry.
Media typeapplication/problem+json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}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
title
string
type
string
key
additional properties
Example generated
{ "errors": { "additionalProperty": [ "example" ] }, "status": 1, "title": "example", "type": "example"}