> ## Documentation Index > Fetch the complete documentation index at: https://docs.rootly.com/llms.txt > Use this file to discover all available pages before exploring further. # Lists AI automations > Requires OAuth scope `ai.automations:read`. ## OpenAPI ````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json get /v1/ai_automations openapi: 3.0.1 info: title: Rootly API v1 version: v1 license: name: Rootly url: https://rootly.com description: >+ # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{"error": "Rate limit exceeded. Try again later."}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ``` x-logo: url: https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png servers: - url: https://api.rootly.com security: [] paths: /v1/ai_automations: get: tags: - AIAutomations summary: Lists AI automations description: Requires OAuth scope `ai.automations:read`. operationId: ListAIAutomations parameters: - name: filter[search] in: query schema: type: string - name: filter[enabled] in: query schema: type: boolean - name: filter[trigger_kind] in: query description: Comma-separated values; any matching trigger kind is included. schema: type: string - name: filter[event_name] in: query description: Comma-separated values; any matching event name is included. schema: type: string - name: filter[created_at][gte] in: query schema: type: string format: date-time - name: filter[created_at][lte] in: query schema: type: string format: date-time - name: sort in: query schema: type: string enum: - name - '-name' - created_at - '-created_at' - updated_at - '-updated_at' responses: '200': description: read OAuth scope permits listing automations content: application/vnd.api+json: schema: $ref: '#/components/schemas/ai_automation_list' '403': description: AI Automations are not enabled content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' '404': description: AI Skills write scope alone does not permit listing automations content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' '422': description: unknown trigger kinds are rejected content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' security: - bearer_auth: [] components: schemas: ai_automation_list: type: object properties: data: type: array items: type: object properties: id: type: string format: uuid type: type: string enum: - ai_automations attributes: type: object allOf: - $ref: '#/components/schemas/ai_automation_attributes' required: - id - type - attributes meta: type: object additionalProperties: true required: - data errors_list: type: object properties: errors: type: array items: type: object properties: title: type: string status: type: string code: type: string nullable: true detail: type: string nullable: true required: - title - status ai_automation_attributes: type: object properties: name: type: string prompt: type: string enabled: type: boolean trigger_kind: type: string enum: - schedule - event schedule: type: object nullable: true properties: frequency: type: string enum: - hourly - daily - weekdays - weekly hour: type: integer nullable: true minimum: 0 maximum: 23 description: Not used for hourly schedules. weekday: type: string nullable: true enum: - MO - TU - WE - TH - FR - SA - SU description: Only used for weekly schedules. schedule_rrule: type: string nullable: true description: >- Custom RRULE. Can't be combined with schedule.frequency, schedule.hour or schedule.weekday; schedule.timezone is allowed. schedule_timezone: type: string nullable: true event_name: type: string nullable: true enum: - incident.created - incident.status_changed - incident.resolved description: null unless trigger_kind is event. conditions: type: object description: >- {} unless trigger_kind is event. Empty object means no conditions. Groups in any are ORed; clauses in all are ANDed. example: any: - all: - field: status operator: eq value: started properties: any: type: array items: type: object properties: all: type: array items: type: object properties: field: type: string enum: - severity - status - to_status operator: type: string enum: - eq - neq - contains - present - blank value: oneOf: - type: string - type: number - type: boolean description: Omitted for present/blank operators. required: - field - operator additionalProperties: false required: - all additionalProperties: false additionalProperties: false destination_kind: type: string enum: - slack_channel - incident_timeline - none destination_slack_channel_id: type: string nullable: true destination_slack_channel_name: type: string nullable: true skill_ids: type: array items: type: string format: uuid limits_enabled: type: boolean description: >- Stored limit values are returned even when false and apply only when this is true. max_credits_per_run: type: number nullable: true description: >- The stored value is returned even when limits are disabled and only applies when limits_enabled is true. rate_limit_runs: type: integer description: >- The stored value is returned even when limits are disabled and only applies when limits_enabled is true. rate_limit_window: type: string enum: - 1_hour - 1_day - 7_days description: >- The stored value is returned even when limits are disabled and only applies when limits_enabled is true. owner_user_id: type: integer nullable: true disabled_reason: type: string nullable: true next_run_at: type: string format: date-time nullable: true last_run_at: type: string format: date-time nullable: true consecutive_failures_count: type: integer created_by_user_id: type: integer nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.