OpenAPI

This describes the OpenAPI that will be produced with the complete configuration for the section.

This project lacks a description of the invoke, batch, and streaming methods. More details on the payload can be found in the langserve documentation, which is used under the hood for langchain.

OpenAPI

This documentation can be found in your project under /docs or /redoc, depending on your preferred style.

Healthcheck Handler

Healthcheck endpoint.

GET/v1/healthcheck

Response

200

Successful Response

Body

application/json

status*Status

availableunavailableerror

system_info*SystemInfo

System information.

Request

JavaScriptCurlPython

const response = await fetch('/v1/healthcheck', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "status": "available",
  "system_info": {
    "version": "text",
    "environment": "development"
  }
}

Invoke Agents Handler

Handle invoke request.

POST/v1/agents/invoke

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/agents/invoke', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Batch Agents Handler

Handle batch request.

POST/v1/agents/batch

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/agents/batch', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Stream Agents Handler

Handle stream request.

POST/v1/agents/stream

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/agents/stream', {
    method: 'POST',
    headers: {},
});
const data = await response.json();