Issue an ingest key
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{pid}/ingest-keys \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"dataset_default": "default",
"require_signature": false
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', dataset_default: 'default', require_signature: false})
};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/ingest-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/ingest-keys"
payload = {
"name": "<string>",
"dataset_default": "default",
"require_signature": False
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"key": "<string>",
"signing_secret": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Ingest keys
Issue an ingest key
Top-level alias: POST /admin/api/ingest-keys. Write role required.
POST
/
admin
/
api
/
projects
/
{pid}
/
ingest-keys
Issue an ingest key
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{pid}/ingest-keys \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"dataset_default": "default",
"require_signature": false
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', dataset_default: 'default', require_signature: false})
};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/ingest-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/ingest-keys"
payload = {
"name": "<string>",
"dataset_default": "default",
"require_signature": False
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"key": "<string>",
"signing_secret": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Path Parameters
Project id (UUID) belonging to the caller workspace.
Body
application/json
Required string length:
1 - 80Dataset used when an ingest request does not name one. A non-string value falls back to default.
Pattern:
^[A-Za-z][A-Za-z0-9_]{0,62}$Only the literal true enables it. When enabled a signing secret is generated and returned once.
Response
Created. key is the full ik_live_ token and signing_secret the whsec_ value - both are shown exactly once and only the key hash / encrypted secret are stored.