Register a webhook endpoint
curl --request POST \
--url https://api.aurous-labs.com/v1/webhook_endpoints \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"url": "https://api.acme.dev/aurous-webhook",
"events": [
"character.completed",
"character.failed",
"image.completed"
],
"description": "Production webhook",
"metadata": {
"env": "prod",
"team": "integrations"
},
"api_key_id": "key_06FD019S0HGR87NSH2KA72HZAC"
}
'import requests
url = "https://api.aurous-labs.com/v1/webhook_endpoints"
payload = {
"url": "https://api.acme.dev/aurous-webhook",
"events": ["character.completed", "character.failed", "image.completed"],
"description": "Production webhook",
"metadata": {
"env": "prod",
"team": "integrations"
},
"api_key_id": "key_06FD019S0HGR87NSH2KA72HZAC"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://api.acme.dev/aurous-webhook',
events: ['character.completed', 'character.failed', 'image.completed'],
description: 'Production webhook',
metadata: {env: 'prod', team: 'integrations'},
api_key_id: 'key_06FD019S0HGR87NSH2KA72HZAC'
})
};
fetch('https://api.aurous-labs.com/v1/webhook_endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aurous-labs.com/v1/webhook_endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://api.acme.dev/aurous-webhook',
'events' => [
'character.completed',
'character.failed',
'image.completed'
],
'description' => 'Production webhook',
'metadata' => [
'env' => 'prod',
'team' => 'integrations'
],
'api_key_id' => 'key_06FD019S0HGR87NSH2KA72HZAC'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aurous-labs.com/v1/webhook_endpoints"
payload := strings.NewReader("{\n \"url\": \"https://api.acme.dev/aurous-webhook\",\n \"events\": [\n \"character.completed\",\n \"character.failed\",\n \"image.completed\"\n ],\n \"description\": \"Production webhook\",\n \"metadata\": {\n \"env\": \"prod\",\n \"team\": \"integrations\"\n },\n \"api_key_id\": \"key_06FD019S0HGR87NSH2KA72HZAC\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aurous-labs.com/v1/webhook_endpoints")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://api.acme.dev/aurous-webhook\",\n \"events\": [\n \"character.completed\",\n \"character.failed\",\n \"image.completed\"\n ],\n \"description\": \"Production webhook\",\n \"metadata\": {\n \"env\": \"prod\",\n \"team\": \"integrations\"\n },\n \"api_key_id\": \"key_06FD019S0HGR87NSH2KA72HZAC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aurous-labs.com/v1/webhook_endpoints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://api.acme.dev/aurous-webhook\",\n \"events\": [\n \"character.completed\",\n \"character.failed\",\n \"image.completed\"\n ],\n \"description\": \"Production webhook\",\n \"metadata\": {\n \"env\": \"prod\",\n \"team\": \"integrations\"\n },\n \"api_key_id\": \"key_06FD019S0HGR87NSH2KA72HZAC\"\n}"
response = http.request(request)
puts response.read_body{
"id": "we_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
"object": "webhook_endpoint",
"url": "https://api.acme.dev/aurous-webhook",
"events": [
"image.completed"
],
"secret_preview": "whsec_8jK...ABCD",
"is_active": true,
"consecutive_failures": 0,
"last_success_at": "2026-05-04T01:00:00Z",
"last_failure_at": "2026-05-04T00:55:00Z",
"metadata": {},
"created_at": "2026-05-03T14:00:00Z",
"updated_at": "2026-05-03T14:00:00Z",
"description": "Production webhook",
"secret": "whsec_8jKpQ4nXabc1234abc...",
"api_key_id": "key_06FD019S0HGR87NSH2KA72HZAC",
"api_key_name": "Production key"
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}Webhooks
Register a webhook endpoint
Mints a new endpoint, generates a signing secret, and returns the secret EXACTLY ONCE in the secret field. Store it on your side — subsequent reads return secret: null. Subscribe to ["*"] to receive every event in the v1.0 taxonomy (the wildcard is expanded at create time; new event types added later do NOT auto-subscribe).
POST
/
v1
/
webhook_endpoints
Register a webhook endpoint
curl --request POST \
--url https://api.aurous-labs.com/v1/webhook_endpoints \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"url": "https://api.acme.dev/aurous-webhook",
"events": [
"character.completed",
"character.failed",
"image.completed"
],
"description": "Production webhook",
"metadata": {
"env": "prod",
"team": "integrations"
},
"api_key_id": "key_06FD019S0HGR87NSH2KA72HZAC"
}
'import requests
url = "https://api.aurous-labs.com/v1/webhook_endpoints"
payload = {
"url": "https://api.acme.dev/aurous-webhook",
"events": ["character.completed", "character.failed", "image.completed"],
"description": "Production webhook",
"metadata": {
"env": "prod",
"team": "integrations"
},
"api_key_id": "key_06FD019S0HGR87NSH2KA72HZAC"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://api.acme.dev/aurous-webhook',
events: ['character.completed', 'character.failed', 'image.completed'],
description: 'Production webhook',
metadata: {env: 'prod', team: 'integrations'},
api_key_id: 'key_06FD019S0HGR87NSH2KA72HZAC'
})
};
fetch('https://api.aurous-labs.com/v1/webhook_endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aurous-labs.com/v1/webhook_endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://api.acme.dev/aurous-webhook',
'events' => [
'character.completed',
'character.failed',
'image.completed'
],
'description' => 'Production webhook',
'metadata' => [
'env' => 'prod',
'team' => 'integrations'
],
'api_key_id' => 'key_06FD019S0HGR87NSH2KA72HZAC'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aurous-labs.com/v1/webhook_endpoints"
payload := strings.NewReader("{\n \"url\": \"https://api.acme.dev/aurous-webhook\",\n \"events\": [\n \"character.completed\",\n \"character.failed\",\n \"image.completed\"\n ],\n \"description\": \"Production webhook\",\n \"metadata\": {\n \"env\": \"prod\",\n \"team\": \"integrations\"\n },\n \"api_key_id\": \"key_06FD019S0HGR87NSH2KA72HZAC\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aurous-labs.com/v1/webhook_endpoints")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://api.acme.dev/aurous-webhook\",\n \"events\": [\n \"character.completed\",\n \"character.failed\",\n \"image.completed\"\n ],\n \"description\": \"Production webhook\",\n \"metadata\": {\n \"env\": \"prod\",\n \"team\": \"integrations\"\n },\n \"api_key_id\": \"key_06FD019S0HGR87NSH2KA72HZAC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aurous-labs.com/v1/webhook_endpoints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://api.acme.dev/aurous-webhook\",\n \"events\": [\n \"character.completed\",\n \"character.failed\",\n \"image.completed\"\n ],\n \"description\": \"Production webhook\",\n \"metadata\": {\n \"env\": \"prod\",\n \"team\": \"integrations\"\n },\n \"api_key_id\": \"key_06FD019S0HGR87NSH2KA72HZAC\"\n}"
response = http.request(request)
puts response.read_body{
"id": "we_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
"object": "webhook_endpoint",
"url": "https://api.acme.dev/aurous-webhook",
"events": [
"image.completed"
],
"secret_preview": "whsec_8jK...ABCD",
"is_active": true,
"consecutive_failures": 0,
"last_success_at": "2026-05-04T01:00:00Z",
"last_failure_at": "2026-05-04T00:55:00Z",
"metadata": {},
"created_at": "2026-05-03T14:00:00Z",
"updated_at": "2026-05-03T14:00:00Z",
"description": "Production webhook",
"secret": "whsec_8jKpQ4nXabc1234abc...",
"api_key_id": "key_06FD019S0HGR87NSH2KA72HZAC",
"api_key_name": "Production key"
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}Authorizations
Your team API key (starts with al_live_).
Headers
Optional API version pin (YYYY-MM-DD). Omit the header to receive the platform default, currently 2026-08-26.
Pattern:
^\d{4}-\d{2}-\d{2}$Example:
"2026-08-26"
Body
application/json
HTTPS endpoint to deliver events to. Plain http:// is rejected.
Maximum string length:
2048Example:
"https://api.acme.dev/aurous-webhook"
Subscribed event types. Pass ["*"] to subscribe to every event currently in the v1.0 taxonomy (the wildcard is expanded at create time — future event additions do NOT auto-subscribe). Available events include image.*, video.*, character.completed / character.failed / character.cancelled, usage.balance_low, and webhook.endpoint_disabled.
Example:
[
"character.completed",
"character.failed",
"image.completed"
]
Optional human-readable label shown in the dashboard.
Example:
"Production webhook"
Optional structured metadata. Echoed verbatim on subsequent reads. Max 50 keys, string values <=500 chars.
Example:
{ "env": "prod", "team": "integrations" }
Bind this endpoint to a single API key by its public key_… id. When set, the endpoint receives ONLY events generated with that key (most-specific routing); unscoped endpoints stop receiving that key's events. Omit (or pass null) for a catch-all endpoint. The key must belong to your team. On PATCH: null = unbind, omit = leave unchanged.
Example:
"key_06FD019S0HGR87NSH2KA72HZAC"
Response
Endpoint created
Opaque endpoint id (we_).
Example:
"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"
Example:
"webhook_endpoint"
Example:
"https://api.acme.dev/aurous-webhook"
Example:
["image.completed"]
Truncated preview of the active secret. Always present in dashboard hints.
Example:
"whsec_8jK...ABCD"
Example:
true
Consecutive 4xx/5xx/timeout/connect errors since the last successful delivery. The endpoint auto-disables at >=20 with no success in 24h (emits webhook.endpoint_disabled to other active endpoints + an email to the team owner).
Example:
0
Timestamp of the most recent 2xx delivery; null if never.
Example:
"2026-05-04T01:00:00Z"
Timestamp of the most recent failed delivery (4xx/5xx/timeout/connect/TLS); null if never.
Example:
"2026-05-04T00:55:00Z"
Echoed customer metadata.
Example:
{}
Example:
"2026-05-03T14:00:00Z"
Example:
"2026-05-03T14:00:00Z"
Example:
"Production webhook"
Plaintext webhook secret. Returned EXACTLY ONCE on POST + /rotate_secret responses; null on every other read. Store on your side and use to verify the Aurous-Webhook-Signature header.
Example:
"whsec_8jKpQ4nXabc1234abc..."
Public id of the API key this endpoint is bound to, or null for a catch-all endpoint. When set, only events generated with that key are delivered here (most-specific routing). Reverts to null if the key is deleted.
Example:
"key_06FD019S0HGR87NSH2KA72HZAC"
Display name of the bound API key; null when unscoped (catch-all).
Example:
"Production key"