List Builds

List all builds for your organization with optional filters

GET /builds

List builds

cURL

curl --request GET \
  --url https://api.pipecat.daily.co/v1/builds \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pipecat.daily.co/v1/builds"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pipecat.daily.co/v1/builds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pipecat.daily.co/v1/builds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipecat.daily.co/v1/builds"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pipecat.daily.co/v1/builds")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pipecat.daily.co/v1/builds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "builds": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "org_abc123",
      "status": "success",
      "region": "us-west",
      "contextHash": "a1b2c3d4e5f6a7b8",
      "dockerfilePath": "Dockerfile",
      "imageUri": "123456789.dkr.ecr.us-west-2.amazonaws.com/pipecat-cloud/org_abc123:a1b2c3d4e5f6a7b8",
      "logsUrl": "<string>",
      "errorMessage": "<string>",
      "contextSizeBytes": 10485760,
      "imageSizeBytes": 524288000,
      "buildDurationSeconds": 120,
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

Filtering Builds

Use query parameters to filter and paginate your build list:

# List all successful builds
curl "https://api.pipecat.daily.co/v1/builds?status=success" \
  -H "Authorization: Bearer $PIPECAT_API_KEY"

# List builds in a specific region
curl "https://api.pipecat.daily.co/v1/builds?region=us-west&limit=10" \
  -H "Authorization: Bearer $PIPECAT_API_KEY"

# Find builds with a specific context hash
curl "https://api.pipecat.daily.co/v1/builds?contextHash=a1b2c3d4e5f6a7b8" \
  -H "Authorization: Bearer $PIPECAT_API_KEY"

Pagination

Results are paginated with limit and offset parameters:

# Get page 2 (items 21-40)
curl "https://api.pipecat.daily.co/v1/builds?limit=20&offset=20" \
  -H "Authorization: Bearer $PIPECAT_API_KEY"

The response includes total to help calculate pagination:

{
  "builds": [...],
  "total": 142,
  "limit": 20,
  "offset": 20
}

Authorizations

Authorization · string · header · required

Authentication using a Pipecat Cloud API token.

Query Parameters

status · enum<string>

Filter by build status.

Available options: pending, building, success, failed, timeout

region · string

Filter by region.

contextHash · string

Filter by context hash.

limit · integer · default: 20

Maximum number of builds to return.

Required range: 1 <= x <= 100

offset · integer · default: 0

Number of builds to skip for pagination.

Required range: x >= 0

Response

200 - application/json

List of builds

builds · object[]

Array of build objects.

Show child attributes

total · integer

Total number of builds matching the filters.

Example:

42

limit · integer

Maximum number of builds returned.

Example:

20

offset · integer

Number of builds skipped.

Example:

0