API Reference — subpackage_agents

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_agents
  description: 'API Reference — subpackage_agents. 8 operations. Lead operation: List agents. Self-contained Naftiko capability
    covering one Resemble Ai business surface.'
  tags:
  - Resemble Ai
  - subpackage_agents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RESEMBLE_AI_API_KEY: RESEMBLE_AI_API_KEY
capability:
  consumes:
  - type: http
    namespace: resemble-ai-subpackage-agents
    baseUri: https://f.cluster.resemble.ai
    description: API Reference — subpackage_agents business capability. Self-contained, no shared references.
    resources:
    - name: agents
      path: /agents
      operations:
      - name: listagents
        method: GET
        description: List agents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: phone_number
          in: query
          type: string
          description: Filter by associated phone number
        - name: advanced
          in: query
          type: boolean
          description: Include detailed configuration
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: createagent
        method: POST
        description: Create agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: agents-capabilities
      path: /agents/capabilities
      operations:
      - name: getagentcapabilities
        method: GET
        description: Get capabilities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
    - name: agents-system-tools
      path: /agents/system-tools
      operations:
      - name: getsystemtools
        method: GET
        description: Get system tools
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
    - name: agents-uuid
      path: /agents/{uuid}
      operations:
      - name: getagent
        method: GET
        description: Get agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: advanced
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: deleteagent
        method: DELETE
        description: Delete agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: updateagent
        method: PATCH
        description: Update agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: agents-uuid-dispatch
      path: /agents/{uuid}/dispatch
      operations:
      - name: dispatchagent
        method: POST
        description: Dispatch agent
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.RESEMBLE_AI_API_KEY}}'
  exposes:
  - type: rest
    namespace: resemble-ai-subpackage-agents-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_agents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/agents
      name: agents
      description: REST surface for agents.
      operations:
      - method: GET
        name: listagents
        description: List agents
        call: resemble-ai-subpackage-agents.listagents
        with:
          phone_number: rest.phone_number
          advanced: rest.advanced
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createagent
        description: Create agent
        call: resemble-ai-subpackage-agents.createagent
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agents/capabilities
      name: agents-capabilities
      description: REST surface for agents-capabilities.
      operations:
      - method: GET
        name: getagentcapabilities
        description: Get capabilities
        call: resemble-ai-subpackage-agents.getagentcapabilities
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agents/system-tools
      name: agents-system-tools
      description: REST surface for agents-system-tools.
      operations:
      - method: GET
        name: getsystemtools
        description: Get system tools
        call: resemble-ai-subpackage-agents.getsystemtools
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agents/{uuid}
      name: agents-uuid
      description: REST surface for agents-uuid.
      operations:
      - method: GET
        name: getagent
        description: Get agent
        call: resemble-ai-subpackage-agents.getagent
        with:
          uuid: rest.uuid
          advanced: rest.advanced
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteagent
        description: Delete agent
        call: resemble-ai-subpackage-agents.deleteagent
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateagent
        description: Update agent
        call: resemble-ai-subpackage-agents.updateagent
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agents/{uuid}/dispatch
      name: agents-uuid-dispatch
      description: REST surface for agents-uuid-dispatch.
      operations:
      - method: POST
        name: dispatchagent
        description: Dispatch agent
        call: resemble-ai-subpackage-agents.dispatchagent
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: resemble-ai-subpackage-agents-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_agents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-agents
      description: List agents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-agents.listagents
      with:
        phone_number: tools.phone_number
        advanced: tools.advanced
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-agent
      description: Create agent
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: resemble-ai-subpackage-agents.createagent
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-capabilities
      description: Get capabilities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-agents.getagentcapabilities
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-system-tools
      description: Get system tools
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-agents.getsystemtools
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-agent
      description: Get agent
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-agents.getagent
      with:
        uuid: tools.uuid
        advanced: tools.advanced
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-agent
      description: Delete agent
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: resemble-ai-subpackage-agents.deleteagent
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-agent
      description: Update agent
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-agents.updateagent
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dispatch-agent
      description: Dispatch agent
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: resemble-ai-subpackage-agents.dispatchagent
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.