Resume Domain
Resume a paused domain (brand) so that its prompts are analyzed again. Its active prompts use prompt credits again.
curl --request POST \
--url https://api.aiclicks.io/api/v1/domains/resume \
--header 'Authorization: Bearer ak_live_xxx' \
--header 'Content-Type: application/json' \
--data '{"domain_id": "8f1d3c0a-2f9b-4c11-9b80-7a82e1f0c3f3"}'
import httpx, os
resp = httpx.post(
"https://api.aiclicks.io/api/v1/domains/resume",
headers={"Authorization": f"Bearer {os.environ['AICLICKS_API_KEY']}"},
json={"domain_id": "8f1d3c0a-2f9b-4c11-9b80-7a82e1f0c3f3"},
)
resp.raise_for_status()
data = resp.json()["data"]
print(data["message"], data["remaining_prompts"], "credits left")
const resp = await fetch("https://api.aiclicks.io/api/v1/domains/resume", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.AICLICKS_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ domain_id: "8f1d3c0a-2f9b-4c11-9b80-7a82e1f0c3f3" }),
});
const { data } = await resp.json();
console.log(data.message, data.remaining_prompts);
{
"data": {
"message": "Domain resumed successfully",
"domain_id": "8f1d3c0a-2f9b-4c11-9b80-7a82e1f0c3f3",
"disabled": false,
"prompts_refunded": null,
"remaining_prompts": 4
},
"generated_at": "2026-11-17T08:31:40.431563+00:00"
}
{
"detail": "Not enough prompt credits to resume this domain. You need 805 but only have 100. Please upgrade your plan or delete some prompts from this domain."
}
{
"detail": "Access denied: User is not a member of the team that owns this domain"
}
{
"detail": "Invalid or revoked API key"
}
{
"detail": "Too many requests. Please try again later."
}
Resumes a paused domain. The next analysis runs include the domain again. Each active prompt of the domain uses one prompt credit of the team. To pause a domain, use POST /api/v1/domains/pause.
If the domain is already active, the call changes nothing and returns "Domain is already active". To see if a domain is paused, read the paused field of GET /api/v1/domains.
The team must have one free prompt credit for each active prompt of the domain. If not, the call returns 400 and the domain stays paused. Check the credits first with GET /api/v1/team-usage.
Authorizations
Your API key in the format Bearer ak_live_<your-key>. Create a key in the dashboard under Settings → Developers. The key must have access to the team that owns domain_id.
Must be application/json.
Body parameters
UUID of the paused domain. Find it with GET /api/v1/domains.
Response
Domain resumed successfully, or Domain is already active when the call changed nothing.
UUID of the domain.
Always false. The domain is active.
Always null for this endpoint.
The prompt credits of the team after the resume. null when the domain was already active.
ISO-8601 time when the server made this response.
Side effects
- The domain is in the next analysis runs again.
- The team uses one prompt credit for each active prompt of the domain.
- The API clears the cache of
GET /api/v1/domains.
Errors
The team does not have enough prompt credits for the active prompts of the domain. Or the subscription of the team is paused. The domain stays paused.
The API key is missing, malformed or revoked.
The caller is not a member of the team of the domain. Or the API key has no access to this domain. Or the plan of the team does not include API access.
The body is not valid. For example, domain_id is missing.
You sent too many requests. Read the Retry-After header to know how long to wait.