Archestra AI

Archestra AI Hooks API

The Hooks API from Archestra AI — 2 operation(s) for hooks.

GitHub OpenAPI

Operations 4

GET /api/hooks Get hooks #
POST /api/hooks Create hook #
PUT /api/hooks/{id} Update hook #
DELETE /api/hooks/{id} Delete hook #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/archestra/openapi/archestra-hooks-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-gemini-generate-content-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-gemini-generate-content-request-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-minimax-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-minimax-chat-completion-request-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-openrouter-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-perplexity-chat-completion-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/archestra:archestra-hooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

archestra-hooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Archestra Hooks API
  version: 1.4.0-rc.47
tags:
- name: Hooks
paths:
  /api/hooks:
    get:
      operationId: getHooks
      tags:
      - Hooks
      description: 'List hook files for an agent


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: query
        name: agentId
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    organizationId:
                      type: string
                    agentId:
                      type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    event:
                      type: string
                      enum:
                      - session_start
                      - pre_tool_use
                      - post_tool_use
                    fileName:
                      type: string
                    content:
                      type: string
                    requirements:
                      type: array
                      items:
                        type: string
                    enabled:
                      type: boolean
                    createdAt:
                      type: string
                      format: date-time
                    updatedAt:
                      type: string
                      format: date-time
                  required:
                  - id
                  - organizationId
                  - agentId
                  - event
                  - fileName
                  - content
                  - requirements
                  - enabled
                  - createdAt
                  - updatedAt
                  additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Get hooks
      x-summary-source: derived
    post:
      operationId: createHook
      tags:
      - Hooks
      description: 'Create a new hook file for an agent


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                agentId:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                event:
                  type: string
                  enum:
                  - session_start
                  - pre_tool_use
                  - post_tool_use
                fileName:
                  type: string
                  minLength: 1
                  maxLength: 255
                  pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*\.(py|sh)$
                content:
                  type: string
                  minLength: 1
                  maxLength: 65536
                requirements:
                  default: []
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                enabled:
                  type: boolean
              required:
              - agentId
              - event
              - fileName
              - content
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  organizationId:
                    type: string
                  agentId:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  event:
                    type: string
                    enum:
                    - session_start
                    - pre_tool_use
                    - post_tool_use
                  fileName:
                    type: string
                  content:
                    type: string
                  requirements:
                    type: array
                    items:
                      type: string
                  enabled:
                    type: boolean
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                - id
                - organizationId
                - agentId
                - event
                - fileName
                - content
                - requirements
                - enabled
                - createdAt
                - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Create hook
      x-summary-source: derived
  /api/hooks/{id}:
    put:
      operationId: updateHook
      tags:
      - Hooks
      description: 'Update an existing hook file


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  enum:
                  - session_start
                  - pre_tool_use
                  - post_tool_use
                fileName:
                  type: string
                  minLength: 1
                  maxLength: 255
                  pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*\.(py|sh)$
                content:
                  type: string
                  minLength: 1
                  maxLength: 65536
                requirements:
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                enabled:
                  type: boolean
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  organizationId:
                    type: string
                  agentId:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  event:
                    type: string
                    enum:
                    - session_start
                    - pre_tool_use
                    - post_tool_use
                  fileName:
                    type: string
                  content:
                    type: string
                  requirements:
                    type: array
                    items:
                      type: string
                  enabled:
                    type: boolean
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                - id
                - organizationId
                - agentId
                - event
                - fileName
                - content
                - requirements
                - enabled
                - createdAt
                - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Update hook
      x-summary-source: derived
    delete:
      operationId: deleteHook
      tags:
      - Hooks
      description: 'Delete a hook file


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                required:
                - success
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Delete hook
      x-summary-source: derived