Pipe API: List

The list pipe API endpoint allows you to get a list of pipes on Langbase with API. This endpoint requires a User or Org API key.

Generate a User/Org API key

You will need to generate an API key to authenticate your requests. For more information, visit the User/Org API key documentation.

GET/beta/org/{org}/pipes

Get a list of org pipes

Get a list of org pipes by sending a GET request to this endpoint.

Required headers

Name
Content-Type
Type
string
Description
Request content type. Needs to be application/json.
Name
Authorization
Type
string
Description
Replace <ORG_API_KEY> with your organization API key.

Required path parameters

Name
org
Type
string
Description
The organization username.
Replace {org} with your organization username.

Get Org Pipes

GET

/beta/org/{org}/pipes

curl https://api.langbase.com/beta/org/{org}/pipes \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer <ORG_API_KEY>"

Response

{
  "pipes" : [
    {
      "name": "test-pipe",
      "type": "chat",
      "description": "This is a pipe test from API",
      "status": "public",
      "api_key": "pipe_4FVBn2DgrzfJf...",
      "owner_login": "langbase",
      "url": "https://langbase.com/langbase/test-pipe"
    },
    ...
  ]
}

GET/beta/user/pipes

Get a list of user pipes

Get a list of user pipes by sending a GET request to this endpoint.

Required headers

Name
Content-Type
Type
string
Description
Request content type. Needs to be application/json.
Name
Authorization
Type
string
Description
Replace <USER_API_KEY> with your User API key.

Get User Pipes

GET

/beta/user/pipes

curl https://api.langbase.com/beta/user/pipes \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer <USER_API_KEY>"

Response

{
  "pipes" : [
    {
      "name": "test-pipe",
      "type": "chat",
      "description": "This is a pipe test from API",
      "status": "public",
      "api_key": "pipe_4FVBn2DgrzfJf...",
      "owner_login": "langbase",
      "url": "https://langbase.com/langbase/test-pipe"
    },
    ...
  ]
}