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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/healthcheck'

200

200

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

Successful Response

Invoke Agents Handler

Handle invoke request.

post

/v1/agents/invoke

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/agents/invoke'

200

200

No body

Successful Response

Batch Agents Handler

Handle batch request.

post

/v1/agents/batch

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/agents/batch'

200

200

No body

Successful Response

Stream Agents Handler

Handle stream request.

post

/v1/agents/stream

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/agents/stream'

200

200

No body

Successful Response