curl --request GET \
--url https://api.aurous-labs.com/v1/webhook_endpoints/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.aurous-labs.com/v1/webhook_endpoints/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.aurous-labs.com/v1/webhook_endpoints/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.aurous-labs.com/v1/webhook_endpoints/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aurous-labs.com/v1/webhook_endpoints/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aurous-labs.com/v1/webhook_endpoints/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
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"
}
}Get a webhook endpoint
Returns the endpoint metadata. secret is always null on reads.
curl --request GET \
--url https://api.aurous-labs.com/v1/webhook_endpoints/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.aurous-labs.com/v1/webhook_endpoints/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.aurous-labs.com/v1/webhook_endpoints/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.aurous-labs.com/v1/webhook_endpoints/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aurous-labs.com/v1/webhook_endpoints/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aurous-labs.com/v1/webhook_endpoints/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
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"
}
}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.
^\d{4}-\d{2}-\d{2}$"2026-08-26"
Path Parameters
Opaque endpoint id.
"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"
Response
Endpoint found
Opaque endpoint id (we_).
"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"
"webhook_endpoint"
"https://api.acme.dev/aurous-webhook"
["image.completed"]
Truncated preview of the active secret. Always present in dashboard hints.
"whsec_8jK...ABCD"
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).
0
Timestamp of the most recent 2xx delivery; null if never.
"2026-05-04T01:00:00Z"
Timestamp of the most recent failed delivery (4xx/5xx/timeout/connect/TLS); null if never.
"2026-05-04T00:55:00Z"
Echoed customer metadata.
{}
"2026-05-03T14:00:00Z"
"2026-05-03T14:00:00Z"
"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.
"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.
"key_06FD019S0HGR87NSH2KA72HZAC"
Display name of the bound API key; null when unscoped (catch-all).
"Production key"

