Skip to main content
POST
Create a new project

Authorizations

x-org-api-key
string
header
default:your-organization-api-key
required

Your Composio organization API key for organization-scoped endpoints.

Body

application/json
name
string
required

A unique name for your project that follows the required format rules

Required string length: 3 - 75
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"my-awesome-project"

should_create_api_key
boolean
default:false

Whether to create an API key for the project. If true, the API key will be created and returned in the response.

Example:

false

api_key_allowed_ips
string<ip>[]

IPv4 or IPv6 addresses allowed to use the project API key. Requires should_create_api_key to be true. Omit to allow requests from any IP address.

Example:
api_key_permissions
object[]

Permission levels for the project API key. Requires should_create_api_key to be true. Omit to create a full-access API key.

Example:
config
object

Configuration for the project. Use zdr_enabled for Zero Data Retention; log_visibility_setting remains supported for existing clients. Do not send both fields.

Response

Project successfully created. Returns the complete project object with generated IDs, webhook secrets, and configuration.

id
string<projectId>
required

Unique identifier for the project

Example:

"pr_1a2b3c4d5e6f"

api_key
string | null
required

API key for the project

Example:

"ak_a1b2c3d4e5f6g7h8i9j0"

name
string

Name of the project

Example:

"My Awesome Project"