Inference

POST/api/v1/inference

Body

application/jsontext/jsonapplication/*+json

messagesnullable array of ChatMessage (object)

environmentnullable string

modelnullable string

tagsnullable array of string

isDebugboolean

maxTokensnullable integer (int32)

seedinteger (int32)

temperaturenullable number (float)

topPnullable number (double)

topKnullable integer (int32)

Response

200

OK

Body

text/plainapplication/jsontext/json

creditsUsedinteger (int64)

llmCostCreditsinteger (int64)

creditsLeftinteger (int64)

millisecondsinteger (int32)

resultIShuttleResponsePayload (object)

pairChatRequestResponsePair (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/inference', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "result": {
    "model": "text",
    "provider": "text",
    "usage": {
      "costUsd": 0
    }
  },
  "pair": {
    "timestamp": "2024-11-21T09:59:04.461Z",
    "response": {
      "id": "text",
      "idCreated": "2024-11-21T09:59:04.461Z",
      "inferenceRequestId": "text",
      "model": "text",
      "provider": "text",
      "usage": {
        "costUsd": 0
      },
      "textResponse": "text",
      "verbatimResponse": "text",
      "userId": "text",
      "tenantId": "text",
      "shuttleRequestId": "text"
    },
    "request": {
      "id": "text",
      "idCreated": "2024-11-21T09:59:04.461Z",
      "shuttleRequestId": "text",
      "messages": [
        {
          "role": "client",
          "text": "text"
        }
      ],
      "model": "text",
      "temperature": 0,
      "topP": 0
    },
    "contextId": "text"
  }
}