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

get

Healthcheck endpoint.

Responses

200

Successful Response

application/json

Healthcheck response.

statusstring · enumRequiredPossible values:

get

/v1/healthcheck

HTTPcURLJavaScriptPython

GET /v1/healthcheck HTTP/1.1
Accept: */*

200

Successful Response

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

Invoke Agents Handler

post

Handle invoke request.

Responses

200

Successful Response

application/json

anyOptional

post

/v1/agents/invoke

HTTPcURLJavaScriptPython

POST /v1/agents/invoke HTTP/1.1
Accept: */*

200

Successful Response

No content

Batch Agents Handler

post

Handle batch request.

Responses

200

Successful Response

application/json

anyOptional

post

/v1/agents/batch

HTTPcURLJavaScriptPython

POST /v1/agents/batch HTTP/1.1
Accept: */*

200

Successful Response

No content

Stream Agents Handler

post

Handle stream request.

Responses

200

Successful Response

application/json

anyOptional

post

/v1/agents/stream

HTTPcURLJavaScriptPython

POST /v1/agents/stream HTTP/1.1
Accept: */*

200

Successful Response

No content