Issue a new scoped API key (raw key returned once)

Requires project role ADMIN+. The raw key is returned exactly once in the response and can never be retrieved again. The resulting key is used as X-API-Key on the ingest/decision/ coupon/metrics/mcp APIs, gated by the scopes granted here.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 120 characters

scopes

required

Array<string>

>= 1 items

Allowed values: ingest:write decision:read coupon:redeem coupon:read metrics:read metrics:write profile:write decision:call tracking:ingest mcp:events_read mcp:events_write mcp:links_write mcp:attribution_read

Responses

201

Created (includes raw key once)

application/json

object

key

object

string

projectId

string

name

string | null

scopes

Array<string>

revoked

boolean

createdAt

string

revokedAt

string | null

keyMasked

string

key

Raw API key — shown only on creation

string

warning

string

400

Missing projectId

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

401

Not authorized

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Needs project ADMIN

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

422

Validation failed

application/json

object

error

required

string

issues

Array<object>

object

path

string

message

string

details

Array<object>

object

key

additional properties

any

key

additional properties

any

Example

1
{
2
  "error": "参数校验失败"
3
}

POST

/api/projects/{projectId}/api-keys

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/api-keys \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "name": "<string>",
7
  "scopes": [
8
    "ingest:write"
9
  ]
10
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/api-keys';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"name":"<string>","scopes":["ingest:write"]}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/api-keys"
4

5
payload = {
6
    "name": "<string>",
7
    "scopes": ["ingest:write"]
8
}
9
headers = {
10
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
11
    "Content-Type": "application/json"
12
}
13

14
response = requests.post(url, json=payload, headers=headers)
15

16
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/api-keys"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"name\": \"<string>\",\n  \"scopes\": [\n    \"ingest:write\"\n  ]\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/api-keys"
13

14
  payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"scopes\": [\n    \"ingest:write\"\n  ]\n}")
15

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

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

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

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

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Created (includes raw key once)

1
{
2
  "key": {
3
    "scopes": [
4
      "ingest:write"
5
    ]
6
  }
7
}

Issue a new scoped API key (raw key returned once)

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

422

Example

Request Body^required

Example^generated

Example^generated

Example^generated