Guide: Run a Pipe using user/org API keys

A step-by-step guide to run a pipe using user/org API keys.


In this guide, we will learn how to run a pipe using user/org keys. We will pass user/org API keys as auth token inside /run endpoint and pass the name of the pipe we want to run.

Let's get started!


Step #1Generate 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.

Step #2Run a pipe with user/org API keys

Lastly, instead of pipe API key, we will pass user/org API key as auth token inside /run endpoint. We will also pass the name of the pipe we want to run.

Run pipe with user/org API keys

POST
/v1/pipes/run
curl https://api.langbase.com/v1/pipes/run \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <USER/ORG_API_KEY>' \
-d '{
	"messages": [
		{
			"role": "user",
			"content": "Hello!"
		}
	],
	"name": "<PIPE_NAME>"
}'