Skip to main content
POST
/
v1
/
connect
/
projects
cURL
curl --request POST \
  --url https://api.pipedream.com/v1/connect/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "app_name": "<string>",
  "support_email": "jsmith@example.com",
  "connect_require_key_auth_test": true
}
'
import { PipedreamClient } from "@pipedream/sdk";

const client = new PipedreamClient({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
projectId: "YOUR_PROJECT_ID"
});
await client.projects.create({
name: "name"
});
from pipedream import Pipedream

client = Pipedream(
project_id="YOUR_PROJECT_ID",
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.projects.create(
name="name",
)
package com.example.usage;

import com.pipedream.api.BaseClient;
import com.pipedream.api.resources.projects.requests.CreateProjectOpts;

public class Example {
public static void main(String[] args) {
BaseClient client = BaseClient.withCredentials("<clientId>", "<clientSecret>")
.build()
;

client.projects().create(
CreateProjectOpts
.builder()
.name("name")
.build()
);
}
}
package main

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

func main() {

url := "https://api.pipedream.com/v1/connect/projects"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"app_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"connect_require_key_auth_test\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
{
  "id": "<string>",
  "name": "<string>",
  "app_name": "<string>",
  "support_email": "jsmith@example.com",
  "connect_require_key_auth_test": true
}
{
"error": "Throttled"
}

Authorizations

Authorization
string
header
required

A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.

Body

application/json
name
string
required

Name of the project

app_name
string

Display name for the Connect application

support_email
string<email>

Support email displayed to end users

connect_require_key_auth_test
boolean

Send a test request to the upstream API when adding Connect accounts for key-based apps

Response

project created

Project that can be accessed via the Connect API

id
string
required

Hash ID for the project

Pattern: ^proj_[0-9A-Za-z]+$
name
string
required

Display name of the project

app_name
string | null

App name shown to Connect users

support_email
string<email> | null

Support email configured for the project

connect_require_key_auth_test
boolean

Send a test request to the upstream API when adding Connect accounts for key-based apps