Skip to main content
PUT
Link an environment to a project

Authorizations

Authorization
string
header
required

Authentication requires a Pipecat Cloud Private API token.

Generate a Private API key from your Dashboard (Settings > API Keys > Private > Create key) and include it as a Bearer token in the Authorization header.

Path Parameters

agentName
string
required

Name of the agent to link as an environment

Body

application/json
parent
string
required

Name of the project the environment belongs to

environmentName
string
required

Its name among the project's environments: two to 50 lowercase letters, digits and dashes, starting and ending with a letter or digit. production is the project itself, and the pr- prefix is reserved for PR previews.

Maximum string length: 50

Response

The stored link

serviceName
string

The agent that was linked

parent
string | null

The project it belongs to, or null when unlinked

environmentName
string | null

Its name among the project's environments, or null when unlinked