POST /v1/projects — Create Project

Use this endpoint to create a new RelayOS project. This is the only endpoint that does not require an Authorization header. On success, you receive a projectId and an apiKey — use the key to authenticate all subsequent requests.

The apiKey is returned only once and cannot be retrieved again. Copy it immediately and store it in a secure secrets manager. If you lose it, you must create a new key via POST /v1/api-keys.

Request

POST https://api.relayos.com.br/v1/projects

string

required

Display name for your project. Used to identify the project in the dashboard and API responses. Example: My Production App.

string

required

Contact email address for the project owner. RelayOS uses this for billing notices and critical alerts.

curl -X POST https://api.relayos.com.br/v1/projects \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Production App",
    "ownerEmail": "you@yourcompany.com"
  }'

Response

A 200 response returns the new project object along with your API key.

string

Unique identifier for the created project.

string

The display name you provided.

string

Your project’s API key. Pass this as a Bearer token in the Authorization header for all authenticated requests. This value is shown only once.

{
  "projectId": "proj_01hwxyz111aaa",
  "name": "My Production App",
  "apiKey": "rly_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Messages

Templates

Projects & Keys

POST /v1/projects — Create Project

Request

Response

​Request

​Response

Request

Response