Avala AI, Inc.

Avala AI, Inc. Agents API

The agents API from Avala AI, Inc. — 4 operation(s) for agents.

Documentation GitHub OpenAPI

Operations 8

GET /agents/ Agents list #

POST /agents/ Agents create #

GET /agents/{uid}/ Agents read #

PUT /agents/{uid}/ Agents update #

PATCH /agents/{uid}/ Agents partial update #

DELETE /agents/{uid}/ Agents delete #

GET /agents/{uid}/executions/ Agents executions #

POST /agents/{uid}/test/ Agents test agent #

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/avala-ai:avala-ai-agents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

openapi: 3.2.0
info:
  title: Avala Agents API
  description: '# Authentication


    ## Generating an API Key


    The Avala SDK uses API keys to authenticate requests. You can create and manage your API keys from the

    Settings page of Mission Control.


    Follow these steps to generate a new API key:


    1. Open your settings page by clicking on your user avatar located at the top right-hand corner of any

    Mission Control screen, and select `Settings`.

    2. From the left-hand sub-menu, select `Security & Identity`.

    3. Click on `New API Key`, enter a name for the key, and then click `Create key`.


    The new key will be automatically copied to your clipboard. Please note, for security reasons, the key

    will not be accessible once you close the window. Ensure you store it in a safe location before closing

    the pop-up modal.


    ### Video walkthrough of API key generation


    ## Authenticating with an API Key


    This is the easiest part! Just add a header named `X-Avala-Api-Key` to your requests and set the

    previously generated API Key as the value.'
  termsOfService: https://avala.ai/legal/terms
  contact:
    email: support@avala.ai
  version: v1
servers:
- url: https://api.avala.ai/api/v1
security:
- API_Key: []
- JWT: []
tags:
- name: Agents
paths:
  /agents/:
    parameters: []
    get:
      operationId: agents_list
      description: GET /api/v1/agents/
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - results
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/AgentRegistration'
      tags:
      - Agents
      summary: Agents list
      x-summary-source: derived
    post:
      operationId: agents_create
      description: POST /api/v1/agents/
      requestBody:
        $ref: '#/components/requestBodies/AgentRegistrationCreate'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistrationCreate'
      tags:
      - Agents
      summary: Agents create
      x-summary-source: derived
  /agents/{uid}/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: agents_read
      description: GET /api/v1/agents/{uid}/
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistrationDetail'
      tags:
      - Agents
      summary: Agents read
      x-summary-source: derived
    put:
      operationId: agents_update
      description: PUT /api/v1/agents/{uid}/
      requestBody:
        $ref: '#/components/requestBodies/AgentRegistrationCreate'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistrationCreate'
      tags:
      - Agents
      summary: Agents update
      x-summary-source: derived
    patch:
      operationId: agents_partial_update
      description: ViewSet for managing agent registrations.
      requestBody:
        $ref: '#/components/requestBodies/AgentRegistrationCreate'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistrationCreate'
      tags:
      - Agents
      summary: Agents partial update
      x-summary-source: derived
    delete:
      operationId: agents_delete
      description: DELETE /api/v1/agents/{uid}/
      responses:
        '204':
          description: ''
      tags:
      - Agents
      summary: Agents delete
      x-summary-source: derived
  /agents/{uid}/executions/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: agents_executions
      description: List executions for a specific agent registration.
      parameters:
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - results
                type: object
                properties:
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/AgentRegistration'
      tags:
      - Agents
      summary: Agents executions
      x-summary-source: derived
  /agents/{uid}/test/:
    parameters:
    - name: uid
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: agents_test_agent
      description: Send a test event to the agent registration.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRegistration'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistration'
      tags:
      - Agents
      summary: Agents test agent
      x-summary-source: derived
components:
  schemas:
    AgentRegistrationDetail:
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
        events:
          description: List of event types this agent subscribes to, e.g. ['task.completed', 'result.submitted'].
          type: array
          items:
            title: Events
            type: string
            maxLength: 100
            minLength: 1
          readOnly: true
        callback_url:
          title: Callback url
          type:
          - string
          - 'null'
          format: uri
          readOnly: true
          minLength: 1
        is_active:
          title: Is active
          type: boolean
          readOnly: true
        project:
          title: Project
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        task_types:
          description: If non-empty, only events for tasks of these types will trigger the agent.
          type: array
          items:
            title: Task types
            type: string
            maxLength: 50
            minLength: 1
          readOnly: true
        execution_stats:
          title: Execution stats
          type: object
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    AgentRegistrationCreate:
      required:
      - name
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
        events:
          description: List of event types this agent subscribes to, e.g. ['task.completed', 'result.submitted'].
          type: array
          items:
            title: Events
            type: string
            maxLength: 100
            minLength: 1
        callback_url:
          title: Callback url
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2048
        secret:
          title: Secret
          description: HMAC signing secret used to verify agent callbacks. Auto-generated if left blank.
          type: string
          maxLength: 255
        is_active:
          title: Is active
          type: boolean
        project:
          title: Project
          type:
          - string
          - 'null'
          format: uuid
        task_types:
          description: If non-empty, only events for tasks of these types will trigger the agent.
          type: array
          items:
            title: Task types
            type: string
            maxLength: 50
            minLength: 1
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    AgentRegistration:
      required:
      - name
      type: object
      properties:
        uid:
          title: Uid
          type: string
          format: uuid
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
        events:
          description: List of event types this agent subscribes to, e.g. ['task.completed', 'result.submitted'].
          type: array
          items:
            title: Events
            type: string
            maxLength: 100
            minLength: 1
        callback_url:
          title: Callback url
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2048
        is_active:
          title: Is active
          type: boolean
        project:
          title: Project
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        task_types:
          description: If non-empty, only events for tasks of these types will trigger the agent.
          type: array
          items:
            title: Task types
            type: string
            maxLength: 50
            minLength: 1
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
  requestBodies:
    AgentRegistrationCreate:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgentRegistrationCreate'
      required: true
  securitySchemes:
    JWT:
      type: apiKey
      name: Authorization
      in: header
      description: JWT token with 'JWT' prefix, e.g., 'JWT eyJhbGciOiJIUzI1NiIsInR...'
    API_Key:
      type: apiKey
      name: X-Avala-Api-Key
      in: header
      description: API key for authentication. Generate one in Mission Control Settings > Security & Identity.