> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative. > - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key. > - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste. > - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`. > - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt # Update an ad rule > Ad Rules. Can spend money or change spend: needs the ads:spend scope and X-Aisa-Confirm: spend; without the header the request is refused with confirmation_required and nothing is sent. Changes an automated rule that can change budgets and turn delivery on or off. Changes any field of a rule except its connection and ad account. Send `campaignIds: null` to check the whole ad account again. Changing the schedule, or enabling a disabled rule, moves the next run; re-sending `enabled: true` on an enabled rule does not. 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 ## 请求规范 * **方法与路径:** PATCH /apis/v1/ads/rules/\{ruleId} * **可用状态:** enabled * **请求 URL 模板:** `https://api.aisa.one/apis/v1/ads/rules/{ruleId}` * **ruleId:** path; 必填 * **connectionId:** query; 必填 * **X-Aisa-Confirm:** header; 可选 * **Runtime 事实版本:** fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 [完整 OpenAPI 定义](https://aisa.one/docs/reference-contracts/zh/aisa-ads.json) 有效请求与价格声明（包括认证和引用的 schema）： ```json theme={null} { "operationId": "patch_aisa_ads_apis_v1_ads_rules_ruleid", "method": "PATCH", "path": "/apis/v1/ads/rules/{ruleId}", "servers": [ { "url": "https://api.aisa.one" } ], "parameters": [ { "in": "path", "name": "ruleId", "required": true, "schema": { "type": "string" } }, { "description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.", "in": "query", "name": "connectionId", "required": true, "schema": { "pattern": "^adc_[0-9A-Za-z]+$", "type": "string" } }, { "description": "Required with the value \"spend\" when the request can spend money or change spend. Without it the request is refused with 409 confirmation_required, which describes what would happen; nothing is sent to the ad platform.", "in": "header", "name": "X-Aisa-Confirm", "required": false, "schema": { "enum": [ "spend" ], "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "example": { "connectionId": "adc_7f3k2m9q", "enabled": false, "name": "Winter launch" }, "schema": { "additionalProperties": true, "properties": { "actions": { "description": "Each type at most once, and at most one of `pause`, `activate` and `adjust_budget`.", "items": { "oneOf": [ { "properties": { "type": { "enum": [ "notify" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "properties": { "maxChangesPerDay": { "description": "At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.", "maximum": 100, "minimum": 1, "type": "integer" }, "type": { "description": "Pause the campaign, ad set or ad.", "enum": [ "pause" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "properties": { "maxChangesPerDay": { "description": "At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.", "maximum": 100, "minimum": 1, "type": "integer" }, "type": { "description": "Reactivate a campaign, ad set or ad a rule paused, once `cooldownMinutes` has passed since the pause. Objects you paused yourself are never touched.", "enum": [ "activate" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "properties": { "direction": { "enum": [ "increase", "decrease" ], "type": "string" }, "limit": { "description": "The budget never goes above this on an increase, or below it on a decrease, in the ad account currency.", "exclusiveMinimum": 0, "type": "number" }, "maxChangesPerDay": { "description": "At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.", "maximum": 100, "minimum": 1, "type": "integer" }, "percent": { "description": "Change in percent: up to 100 for an increase, up to 90 for a decrease.", "maximum": 100, "minimum": 1, "type": "integer" }, "type": { "description": "Change the daily budget. Not on ad-level rules (an ad has no budget), and on Google it needs a campaign-level rule (ad groups have no budget of their own).", "enum": [ "adjust_budget" ], "type": "string" } }, "required": [ "direction", "limit", "percent", "type" ], "type": "object" } ] }, "minItems": 1, "type": "array" }, "campaignIds": { "description": "Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.", "items": { "type": "string" }, "maxItems": 100, "minItems": 1, "type": [ "array", "null" ] }, "conditions": { "description": "Every condition must hold for an object to match. A rate with no denominator (a CPA with no conversions) never matches.", "properties": { "all": { "items": { "properties": { "metric": { "anyOf": [ { "enum": [ "spend", "impressions", "clicks", "conversions", "ctr", "cpc", "cpm", "cpa", "roas", "reach", "frequency" ] }, { "pattern": "^result:[a-z][a-z0-9_]{0,39}$" } ], "description": "`ctr` is a percentage. `spend`, `cpc`, `cpm` and `cpa` are in the ad account currency. `reach` and `frequency` use the platform's de-duplicated reach, so they are accepted on Meta and TikTok only.", "type": "string" }, "op": { "enum": [ ">", ">=", "<", "<=" ], "type": "string" }, "value": { "minimum": 0, "type": "number" }, "window": { "description": "Days in the ad account's own timezone. `last_7d` is the 7 full days before today; only `today` reads the day in progress.", "enum": [ "today", "yesterday", "last_3d", "last_7d", "last_14d", "last_30d" ], "type": "string" } }, "required": [ "metric", "op", "value", "window" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "all" ], "type": "object" }, "connectionId": { "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.", "pattern": "^adc_[0-9A-Za-z]+$", "type": "string" }, "cooldownMinutes": { "maximum": 43200, "minimum": 0, "type": "integer" }, "enabled": { "type": "boolean" }, "level": { "description": "Whether the rule checks campaigns, ad sets or single ads. Each one is evaluated on its own.", "enum": [ "campaign", "adset", "ad" ], "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule": { "properties": { "everyMinutes": { "description": "How often the rule runs, in minutes.", "enum": [ 60, 180, 360, 720, 1440 ], "type": "integer" } }, "required": [ "everyMinutes" ], "type": "object" } }, "type": "object" } } }, "required": true }, "x-aisa-status": "enabled", "x-aisa-pricing": { "description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.", "kind": "no_customer_charge" }, "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } } } ``` ## 费用与请求规则 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口，执行前请针对完整请求获取免费报价；执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。 ## OpenAPI ````yaml reference-contracts/zh/aisa-ads.json PATCH /apis/v1/ads/rules/{ruleId} openapi: 3.1.0 info: description: '' title: AIsa Ads version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: [] x-aisa-document: facts_hash: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 generator_version: '3' protocol_version: '1' schema_version: '1' composer_version: '27' response_pending: [] document_hash: sha256:ba353f59e89e1ebabe0e301d8ef57d3cbfa6bb406a8c591ee9c3833d64b60520 x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: aisa-ads x-aisa-catalogs: aisa-ads: title: AIsa Ads description: '' x-aisa-document: facts_hash: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 generator_version: '3' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/ads/rules/{ruleId}: patch: summary: Update an ad rule description: >- Ad Rules. Can spend money or change spend: needs the ads:spend scope and X-Aisa-Confirm: spend; without the header the request is refused with confirmation_required and nothing is sent. Changes an automated rule that can change budgets and turn delivery on or off. Changes any field of a rule except its connection and ad account. Send `campaignIds: null` to check the whole ad account again. Changing the schedule, or enabling a disabled rule, moves the next run; re-sending `enabled: true` on an enabled rule does not. 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 operationId: patch_aisa_ads_apis_v1_ads_rules_ruleid parameters: - in: path name: ruleId required: true schema: type: string - description: >- The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead. in: query name: connectionId required: true schema: pattern: ^adc_[0-9A-Za-z]+$ type: string - description: >- Required with the value "spend" when the request can spend money or change spend. Without it the request is refused with 409 confirmation_required, which describes what would happen; nothing is sent to the ad platform. in: header name: X-Aisa-Confirm required: false schema: enum: - spend type: string requestBody: content: application/json: example: connectionId: adc_7f3k2m9q enabled: false name: Winter launch schema: additionalProperties: true properties: actions: description: >- Each type at most once, and at most one of `pause`, `activate` and `adjust_budget`. items: oneOf: - properties: type: enum: - notify type: string required: - type type: object - properties: maxChangesPerDay: description: >- At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later. maximum: 100 minimum: 1 type: integer type: description: Pause the campaign, ad set or ad. enum: - pause type: string required: - type type: object - properties: maxChangesPerDay: description: >- At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later. maximum: 100 minimum: 1 type: integer type: description: >- Reactivate a campaign, ad set or ad a rule paused, once `cooldownMinutes` has passed since the pause. Objects you paused yourself are never touched. enum: - activate type: string required: - type type: object - properties: direction: enum: - increase - decrease type: string limit: description: >- The budget never goes above this on an increase, or below it on a decrease, in the ad account currency. exclusiveMinimum: 0 type: number maxChangesPerDay: description: >- At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later. maximum: 100 minimum: 1 type: integer percent: description: >- Change in percent: up to 100 for an increase, up to 90 for a decrease. maximum: 100 minimum: 1 type: integer type: description: >- Change the daily budget. Not on ad-level rules (an ad has no budget), and on Google it needs a campaign-level rule (ad groups have no budget of their own). enum: - adjust_budget type: string required: - direction - limit - percent - type type: object minItems: 1 type: array campaignIds: description: >- Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found. items: type: string maxItems: 100 minItems: 1 type: - array - 'null' conditions: description: >- Every condition must hold for an object to match. A rate with no denominator (a CPA with no conversions) never matches. properties: all: items: properties: metric: anyOf: - enum: - spend - impressions - clicks - conversions - ctr - cpc - cpm - cpa - roas - reach - frequency - pattern: ^result:[a-z][a-z0-9_]{0,39}$ description: >- `ctr` is a percentage. `spend`, `cpc`, `cpm` and `cpa` are in the ad account currency. `reach` and `frequency` use the platform's de-duplicated reach, so they are accepted on Meta and TikTok only. type: string op: enum: - '>' - '>=' - < - <= type: string value: minimum: 0 type: number window: description: >- Days in the ad account's own timezone. `last_7d` is the 7 full days before today; only `today` reads the day in progress. enum: - today - yesterday - last_3d - last_7d - last_14d - last_30d type: string required: - metric - op - value - window type: object maxItems: 10 minItems: 1 type: array required: - all type: object connectionId: description: >- The ads connection (adc_...), when not sent as the connectionId query parameter. pattern: ^adc_[0-9A-Za-z]+$ type: string cooldownMinutes: maximum: 43200 minimum: 0 type: integer enabled: type: boolean level: description: >- Whether the rule checks campaigns, ad sets or single ads. Each one is evaluated on its own. enum: - campaign - adset - ad type: string name: maxLength: 200 minLength: 1 type: string schedule: properties: everyMinutes: description: How often the rule runs, in minutes. enum: - 60 - 180 - 360 - 720 - 1440 type: integer required: - everyMinutes type: object type: object required: true responses: '200': content: application/json: schema: properties: rule: properties: actions: description: >- Each type at most once, and at most one of `pause`, `activate` and `adjust_budget`. items: oneOf: - properties: type: enum: - notify type: string required: - type type: object - properties: maxChangesPerDay: description: >- At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later. maximum: 100 minimum: 1 type: integer type: description: Pause the campaign, ad set or ad. enum: - pause type: string required: - type type: object - properties: maxChangesPerDay: description: >- At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later. maximum: 100 minimum: 1 type: integer type: description: >- Reactivate a campaign, ad set or ad a rule paused, once `cooldownMinutes` has passed since the pause. Objects you paused yourself are never touched. enum: - activate type: string required: - type type: object - properties: direction: enum: - increase - decrease type: string limit: description: >- The budget never goes above this on an increase, or below it on a decrease, in the ad account currency. exclusiveMinimum: 0 type: number maxChangesPerDay: description: >- At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later. maximum: 100 minimum: 1 type: integer percent: description: >- Change in percent: up to 100 for an increase, up to 90 for a decrease. maximum: 100 minimum: 1 type: integer type: description: >- Change the daily budget. Not on ad-level rules (an ad has no budget), and on Google it needs a campaign-level rule (ad groups have no budget of their own). enum: - adjust_budget type: string required: - direction - limit - percent - type type: object minItems: 1 type: array adAccountId: description: Platform ad account ID. type: string campaignIds: description: >- Platform campaign IDs the rule is limited to. Null checks the whole ad account. items: type: string type: - array - 'null' conditions: description: >- Every condition must hold for an object to match. A rate with no denominator (a CPA with no conversions) never matches. properties: all: items: additionalProperties: true type: object maxItems: 10 minItems: 1 type: array required: - all type: object connectionId: description: The ads connection (adc_...) the object belongs to. type: - string - 'null' cooldownMinutes: type: integer createdAt: format: date-time type: string enabled: type: boolean id: type: string lastRunAt: format: date-time type: - string - 'null' level: description: >- Whether the rule checks campaigns, ad sets or single ads. Each one is evaluated on its own. enum: - campaign - adset - ad type: string name: type: string nextRunAt: description: Null while the rule is disabled. format: date-time type: - string - 'null' platform: description: >- Ad platform, for example `facebook` (Meta) or `google`. type: string schedule: properties: everyMinutes: description: How often the rule runs, in minutes. enum: - 60 - 180 - 360 - 720 - 1440 type: integer required: - everyMinutes type: object updatedAt: format: date-time type: string required: - actions - adAccountId - campaignIds - conditions - cooldownMinutes - createdAt - enabled - id - lastRunAt - level - name - nextRunAt - platform - schedule - updatedAt type: object required: - rule type: object description: Rule updated default: content: application/json: schema: properties: error: properties: code: type: - string - 'null' details: additionalProperties: {} type: - object - 'null' message: type: - string - 'null' param: type: - string - 'null' retryHint: type: - string - 'null' retryable: type: - boolean - 'null' type: type: - string - 'null' type: - object - 'null' type: object description: Error. The code field is stable; see the error catalog. components: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.