Getting Started

Before using the Auto API, you need to create an Organization and a Project. The Project holds your database connection. All subsequent API calls use the IDs generated here.

Setup Flow

---

Step 1 — Create Organization

Creates a new organization. If the org_id already exists, returns 208 Already Reported — this is safe to ignore and proceed to Step 2.

Request Fields

Field	Type	Required	Description
org_id	string	✅	Unique ID for the org — generate a ULID
name	string	✅	Display name of the organization
abbreviation	string	✅	Short slug — lowercase, no spaces
admin_email	string	✅	Primary admin email
admin_name	string	✅	Primary admin name
address	string	✅	Street address
state	string	✅	State / province
country	string	✅	Country
pin_code	string	✅	Postal code

Response

Code	Meaning
201 Created	Organization created successfully
208 Already Reported	Org with this org_id already exists — safe to proceed

---

Step 2 — Create Project

Creates a project under your organization and registers the database connection. After creation, note the X-Project-Id and X-Space-Id returned — you will need them for all Auto API calls.

Request Fields

Field	Type	Required	Description
name	string	✅	Display name of the project
abbreviation	string	✅	Short slug — lowercase, no spaces
description	string	❌	Optional description
database[].host	string	✅	Database host
database[].port	string	✅	Database port (e.g. 3306 for MySQL)
database[].username	string	✅	Database username
database[].password	string	✅	Database password
database[].db_name	string	✅	Database name
database[].db_type	string	✅	Database type — e.g. mysql, postgres
database[].connect_timeout_secs	integer	✅	Connection timeout in seconds
database[].idle_timeout_secs	integer	✅	Idle connection timeout
database[].max_open_connections	integer	✅	Max open connections in pool
database[].max_idle_connections	integer	✅	Max idle connections in pool

Response

Code	Meaning
201 Created	Project created — response includes project_id and space_id
208 Already Reported	Project abbreviation already exists under this org