Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.relayos.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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
​
name
string
required
Display name for your project. Used to identify the project in the dashboard and API responses. Example: My Production App.
​
ownerEmail
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.
​
projectId
string
Unique identifier for the created project.
​
name
string
The display name you provided.
​
apiKey
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"
}