Amigo

Amigo Agents API

The Agents API from Amigo — 4 operation(s) for agents.

GitHub OpenAPI

Operations 8

POST /v1/{workspace_id}/agents Create an agent #
GET /v1/{workspace_id}/agents List agents #
GET /v1/{workspace_id}/agents/{agent_id} Get an agent #
PUT /v1/{workspace_id}/agents/{agent_id} Update an agent #
DELETE /v1/{workspace_id}/agents/{agent_id} Delete an agent #
POST /v1/{workspace_id}/agents/{agent_id}/versions Create an agent version #
GET /v1/{workspace_id}/agents/{agent_id}/versions List agent versions #
GET /v1/{workspace_id}/agents/{agent_id}/versions/{version} Get an agent version #

Documentation

📖
Documentation
https://docs.amigo.ai/developer-guide/classic-api
📖
Documentation
https://docs.amigo.ai/developer-guide/platform-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/openapi/amigo-agents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-agent-version-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-create-agent-version-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-agent-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-paginated-response-agent-version-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-paginated-response-agent-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amigo/refs/heads/main/json-schema/amigo-update-agent-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/amigo:amigo-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

amigo-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Platform Agents API
  description: Management API for the Amigo platform. Provides CRUD operations for workspaces, API keys, and resources.
  version: 1.0.0
servers:
- url: https://api.platform.amigo.ai
  description: Production
security:
- BearerAuth: []
tags:
- name: Agents
paths:
  /v1/{workspace_id}/agents:
    post:
      tags:
      - Agents
      summary: Create an agent
      description: Create a new agent in a workspace. Requires `Agent.create` permission.
      operationId: create-agent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '404':
          description: Not found.
        '409':
          description: Name already taken.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Invalid request body.
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
    get:
      tags:
      - Agents
      summary: List agents
      description: List agents in a workspace with pagination. Requires `Agent.view` permission.
      operationId: list-agents
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/SearchString'
          - type: 'null'
          title: Search
      - name: sort_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sort By
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          exclusiveMinimum: 0
          default: 10
          title: Limit
      - name: continuation_token
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Continuation Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AgentResponse_'
        '404':
          description: Not found.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/{workspace_id}/agents/{agent_id}:
    get:
      tags:
      - Agents
      summary: Get an agent
      description: Retrieve an agent by ID. Requires `Agent.view` permission.
      operationId: get-agent
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '404':
          description: Not found.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Agents
      summary: Update an agent
      description: Update an agent's name or description. Requires `Agent.update` permission.
      operationId: update-agent
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '404':
          description: Not found.
        '409':
          description: Name already taken.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Invalid request body.
    delete:
      tags:
      - Agents
      summary: Delete an agent
      description: Delete an agent. Agent versions are retained. Requires `Agent.delete` permission.
      operationId: delete-agent
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      responses:
        '204':
          description: Successful Response
        '404':
          description: Not found.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/{workspace_id}/agents/{agent_id}/versions:
    post:
      tags:
      - Agents
      summary: Create an agent version
      description: Create a new version of an agent. Version number is auto-incremented. Requires `Agent.create` permission for the first version and `Agent.update` permission afterward.
      operationId: create-agent-version
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentVersionRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentVersionResponse'
        '404':
          description: Not found.
        '409':
          description: Name already taken.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Invalid request body.
    get:
      tags:
      - Agents
      summary: List agent versions
      description: List versions of an agent with pagination. Requires `Agent.view` permission.
      operationId: list-agent-versions
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      - name: sort_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sort By
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          exclusiveMinimum: 0
          default: 10
          title: Limit
      - name: continuation_token
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Continuation Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AgentVersionResponse_'
        '404':
          description: Not found.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/{workspace_id}/agents/{agent_id}/versions/{version}:
    get:
      tags:
      - Agents
      summary: Get an agent version
      description: Retrieve a specific agent version by number, or 'latest'. Requires `Agent.view` permission.
      operationId: get-agent-version
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      - name: version
        in: path
        required: true
        schema:
          anyOf:
          - type: integer
          - type: string
          title: Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentVersionResponse'
        '404':
          description: Not found.
        '403':
          description: Insufficient permissions.
        '401':
          description: Missing or invalid API key.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UpdateAgentRequest:
      properties:
        name:
          anyOf:
          - $ref: '#/components/schemas/NameString'
          - type: 'null'
        description:
          anyOf:
          - $ref: '#/components/schemas/DescriptionString'
          - type: 'null'
      type: object
      title: UpdateAgentRequest
    CreateAgentRequest:
      properties:
        name:
          $ref: '#/components/schemas/NameString'
        description:
          $ref: '#/components/schemas/DescriptionString'
          default: ''
      type: object
      required:
      - name
      title: CreateAgentRequest
    PaginatedResponse_AgentVersionResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AgentVersionResponse'
          type: array
          title: Items
        has_more:
          type: boolean
          title: Has More
        continuation_token:
          anyOf:
          - type: integer
          - type: 'null'
          title: Continuation Token
        total:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total
      type: object
      required:
      - items
      - has_more
      title: PaginatedResponse[AgentVersionResponse]
    AgentVersionResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
        agent_id:
          type: string
          format: uuid
          title: Agent Id
        version:
          type: integer
          title: Version
        name:
          type: string
          title: Name
        initials:
          type: string
          title: Initials
        identity:
          $ref: '#/components/schemas/Identity'
        voice_config:
          anyOf:
          - $ref: '#/components/schemas/VoiceConfig'
          - type: 'null'
        background:
          type: string
          title: Background
        behaviors:
          items:
            type: string
          type: array
          title: Behaviors
        communication_patterns:
          items:
            type: string
          type: array
          title: Communication Patterns
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - workspace_id
      - agent_id
      - version
      - name
      - initials
      - identity
      - voice_config
      - background
      - behaviors
      - communication_patterns
      - created_at
      - updated_at
      title: AgentVersionResponse
    SearchString:
      type: string
      maxLength: 200
      minLength: 1
    LanguageProviderEntry:
      properties:
        provider:
          type: string
          enum:
          - cartesia
          - elevenlabs
          - groq
          title: Provider
        config:
          additionalProperties: true
          type: object
          maxProperties: 20
          title: Config
      type: object
      required:
      - provider
      title: LanguageProviderEntry
      description: Per-language TTS provider configuration.
    RelationshipToDeveloper:
      properties:
        ownership:
          type: string
          title: Ownership
        type:
          type: string
          title: Type
        conversation_visibility:
          type: string
          title: Conversation Visibility
        thought_visibility:
          type: string
          title: Thought Visibility
      type: object
      required:
      - ownership
      - type
      - conversation_visibility
      - thought_visibility
      title: RelationshipToDeveloper
    DescriptionString:
      type: string
      maxLength: 2000
    BackgroundString:
      type: string
      maxLength: 10000
    AgentResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        latest_version:
          type: integer
          title: Latest Version
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - workspace_id
      - name
      - description
      - created_at
      - updated_at
      title: AgentResponse
    NameString:
      type: string
      maxLength: 256
      minLength: 1
    PaginatedResponse_AgentResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AgentResponse'
          type: array
          title: Items
        has_more:
          type: boolean
          title: Has More
        continuation_token:
          anyOf:
          - type: integer
          - type: 'null'
          title: Continuation Token
        total:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total
      type: object
      required:
      - items
      - has_more
      title: PaginatedResponse[AgentResponse]
    Identity:
      properties:
        name:
          type: string
          title: Name
        role:
          type: string
          title: Role
        developed_by:
          type: string
          title: Developed By
        default_spoken_language:
          type: string
          title: Default Spoken Language
        relationship_to_developer:
          $ref: '#/components/schemas/RelationshipToDeveloper'
      type: object
      required:
      - name
      - role
      - developed_by
      - default_spoken_language
      title: Identity
    VoiceConfig:
      properties:
        voice_id:
          type: string
          title: Voice Id
        stability:
          type: number
          title: Stability
          default: 0
        similarity_boost:
          type: number
          title: Similarity Boost
          default: 0
        style:
          type: number
          title: Style
          default: 0
        tts_provider:
          anyOf:
          - type: string
            enum:
            - cartesia
            - elevenlabs
            - groq
          - type: 'null'
          title: Tts Provider
        tts_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Tts Config
        language_providers:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/LanguageProviderEntry'
            type: object
            maxProperties: 10
          - type: 'null'
          title: Language Providers
        session_provider:
          anyOf:
          - type: string
            enum:
            - amigo
            - gpt_realtime
            - gpt_live
          - type: 'null'
          title: Session Provider
      type: object
      required:
      - voice_id
      title: VoiceConfig
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CreateAgentVersionRequest:
      properties:
        name:
          $ref: '#/components/schemas/NameString'
        initials:
          type: string
          maxLength: 10
          title: Initials
          default: ''
        identity:
          $ref: '#/components/schemas/Identity'
        voice_config:
          anyOf:
          - $ref: '#/components/schemas/VoiceConfig'
          - type: 'null'
        background:
          $ref: '#/components/schemas/BackgroundString'
          default: ''
        behaviors:
          items:
            type: string
            maxLength: 2000
          type: array
          maxItems: 200
          title: Behaviors
        communication_patterns:
          items:
            type: string
            maxLength: 2000
          type: array
          maxItems: 200
          title: Communication Patterns
      type: object
      required:
      - name
      - identity
      title: CreateAgentVersionRequest
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key issued via `POST /v1/{workspace_id}/api-keys`. Pass the returned `api_key` value as a Bearer token.