Skip to main content
GET
Get build logs

Streaming Logs During Build

You can poll this endpoint during a build to stream logs in real-time. The endpoint returns the latest logs each time you call it:

Pagination

Use the limit query parameter to control how many log lines are returned:
Logs may be empty if the build was just created and hasn’t started executing yet. Continue polling until logs appear or the build completes.

Debugging Failed Builds

When a build fails, use this endpoint to diagnose the issue:
Common issues visible in build logs include:
  • Missing dependencies in requirements.txt
  • Dockerfile syntax errors
  • Failed pip install commands
  • Missing files referenced in COPY instructions

Authorizations

Authorization
string
header
required

Authentication using a Pipecat Cloud API token.

Path Parameters

buildId
string<uuid>
required

Unique identifier of the build.

Query Parameters

limit
integer
default:500

Maximum number of log events to return.

Required range: 1 <= x <= 10000

Response

Build logs retrieved successfully

logs
string[]
required

Array of log lines from the build process. May be empty if the build hasn't started generating logs yet.

Example:
nextToken
string

Pagination token for retrieving additional logs. Present when more logs are available.

Example:

"eyJuZXh0VG9rZW4iOiAiYWJjMTIzIn0="