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/agentrux-com:agentrux-com-console-alias-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: AgenTrux Console Alias API
  version: 0.1.0
tags:
- name: console-alias
paths:
  /console/aliases:
    post:
      tags:
      - console-alias
      summary: Create Alias Endpoint
      operationId: create_alias_endpoint_console_aliases_post
      parameters:
      - name: X-Workspace-Alias-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Workspace-Alias-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAliasBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Create Alias Endpoint Console Aliases Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - console-alias
      summary: List Aliases Endpoint
      operationId: list_aliases_endpoint_console_aliases_get
      parameters:
      - name: account_id
        in: query
        required: true
        schema:
          type: string
          description: acc_<uuid> or org_<uuid>
          title: Account Id
        description: acc_<uuid> or org_<uuid>
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: (legacy) cursor (ali_<uuid>)
          title: After
        description: (legacy) cursor (ali_<uuid>)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          description: 1..200
          default: 50
          title: Limit
        description: 1..200
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Aliases Endpoint Console Aliases Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}:
    get:
      tags:
      - console-alias
      summary: Get Alias Endpoint
      operationId: get_alias_endpoint_console_aliases__ali_id__get
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Alias Endpoint Console Aliases  Ali Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - console-alias
      summary: Patch Alias Endpoint
      operationId: patch_alias_endpoint_console_aliases__ali_id__patch
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAliasBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Patch Alias Endpoint Console Aliases  Ali Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - console-alias
      summary: Delete Alias Endpoint
      operationId: delete_alias_endpoint_console_aliases__ali_id__delete
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/trusts:
    get:
      tags:
      - console-alias
      summary: List Alias Trusts Endpoint
      operationId: list_alias_trusts_endpoint_console_aliases__ali_id__trusts_get
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Alias Trusts Endpoint Console Aliases  Ali Id  Trusts Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - console-alias
      summary: Establish Alias Trust Endpoint
      operationId: establish_alias_trust_endpoint_console_aliases__ali_id__trusts_post
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EstablishTrustBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Establish Alias Trust Endpoint Console Aliases  Ali Id  Trusts Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/share-trust:
    post:
      tags:
      - console-alias
      summary: Share Alias Trust Endpoint
      description: 'Phase Z step Z-1b: email picker で alias_trust を直接確立 (cross-account OK).


        旧 invitation flow (`POST /console/grants/invite-codes`) は Z-2 で削除予定。

        direction: from=caller_alias (grantor) → to=grantee.primary_alias_id。'
      operationId: share_alias_trust_endpoint_console_aliases__ali_id__share_trust_post
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareTrustBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Share Alias Trust Endpoint Console Aliases  Ali Id  Share Trust Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/trusts/{trs_id}:
    delete:
      tags:
      - console-alias
      summary: Revoke Alias Trust Endpoint
      operationId: revoke_alias_trust_endpoint_console_aliases__ali_id__trusts__trs_id__delete
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      - name: trs_id
        in: path
        required: true
        schema:
          type: string
          title: Trs Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/workspace/current:
    get:
      tags:
      - console-alias
      summary: Get Workspace Current
      description: 'spec §4-1-1: header X-Workspace-Alias-Id 必須、 alias 詳細 + counts を返す.'
      operationId: get_workspace_current_console_workspace_current_get
      parameters:
      - name: X-Workspace-Alias-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Workspace-Alias-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Workspace Current Console Workspace Current Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/share:
    post:
      tags:
      - console-alias
      summary: Share Alias Endpoint
      operationId: share_alias_endpoint_console_aliases__ali_id__share_post
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Share Alias Endpoint Console Aliases  Ali Id  Share Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - console-alias
      summary: Unshare Alias Endpoint
      operationId: unshare_alias_endpoint_console_aliases__ali_id__share_delete
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Unshare Alias Endpoint Console Aliases  Ali Id  Share Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/payload-objects:
    get:
      tags:
      - console-alias
      summary: List Payload Objects Endpoint
      description: 'alias scope の payload_objects 一覧 (Phase 4.11.5、 4.11.1 標準準拠).


        Query (4.11.1 標準):

        - q: object_key / id の部分一致

        - sort: created_at / uploaded_at / committed_at / expires_at / size_bytes

        - filter[state]: pending|uploaded|committed|expired

        - filter[topic_id]: top_ で絞り込み

        - cursor / limit: keyset (created_at, id)


        A4: alias 所有確認 + topic JOIN で alias 経由のみ visible。'
      operationId: list_payload_objects_endpoint_console_aliases__ali_id__payload_objects_get
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Payload Objects Endpoint Console Aliases  Ali Id  Payload Objects Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/avatar/presign:
    post:
      tags:
      - console-alias
      summary: Presign Alias Avatar Endpoint
      operationId: presign_alias_avatar_endpoint_console_aliases__ali_id__avatar_presign_post
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/_PresignAvatarBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Presign Alias Avatar Endpoint Console Aliases  Ali Id  Avatar Presign Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/avatar/commit:
    post:
      tags:
      - console-alias
      summary: Commit Alias Avatar Endpoint
      operationId: commit_alias_avatar_endpoint_console_aliases__ali_id__avatar_commit_post
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/_CommitAvatarBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Commit Alias Avatar Endpoint Console Aliases  Ali Id  Avatar Commit Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /console/aliases/{ali_id}/avatar:
    get:
      tags:
      - console-alias
      summary: Get Alias Avatar Endpoint
      operationId: get_alias_avatar_endpoint_console_aliases__ali_id__avatar_get
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - console-alias
      summary: Delete Alias Avatar Endpoint
      operationId: delete_alias_avatar_endpoint_console_aliases__ali_id__avatar_delete
      parameters:
      - name: ali_id
        in: path
        required: true
        schema:
          type: string
          title: Ali Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    _CommitAvatarBody:
      properties:
        avatar_id:
          type: string
          minLength: 1
          title: Avatar Id
      additionalProperties: false
      type: object
      required:
      - avatar_id
      title: _CommitAvatarBody
    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
    CreateAliasBody:
      properties:
        display_name:
          type: string
          maxLength: 64
          minLength: 1
          title: Display Name
        description:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Description
        avatar_image_url:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          title: Avatar Image Url
        background_image_url:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          title: Background Image Url
        admin_email:
          anyOf:
          - type: string
            maxLength: 254
          - type: 'null'
          title: Admin Email
      additionalProperties: false
      type: object
      required:
      - display_name
      title: CreateAliasBody
      description: 'Codex impl review #4 反映: 未知フィールド (`is_shared` 等) は 422 INVALID で reject。


        `/share` は `POST /console/aliases/{ali_id}/share` で別途実装済 (Phase 4.1e、

        本 file 末尾 share_alias_endpoint / unshare_alias_endpoint、 test_phase4_1e_workspace_share.py 8/8 pass)。'
    EstablishTrustBody:
      properties:
        trustee_alias_id:
          type: string
          minLength: 1
          title: Trustee Alias Id
        direction:
          type: string
          enum:
          - outbound
          - inbound
          title: Direction
          default: outbound
      additionalProperties: false
      type: object
      required:
      - trustee_alias_id
      title: EstablishTrustBody
    ShareTrustBody:
      properties:
        grantee_email:
          type: string
          maxLength: 320
          minLength: 3
          title: Grantee Email
      type: object
      required:
      - grantee_email
      title: ShareTrustBody
    _PresignAvatarBody:
      properties:
        size_bytes:
          type: integer
          maximum: 10485760.0
          exclusiveMinimum: 0.0
          title: Size Bytes
        content_type:
          type: string
          maxLength: 128
          minLength: 1
          title: Content Type
        checksum_sha256:
          anyOf:
          - type: string
            maxLength: 128
          - type: 'null'
          title: Checksum Sha256
      additionalProperties: false
      type: object
      required:
      - size_bytes
      - content_type
      title: _PresignAvatarBody
    PatchAliasBody:
      properties:
        display_name:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Display Name
        description:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Description
        avatar_image_url:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          title: Avatar Image Url
        background_image_url:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          title: Background Image Url
        admin_email:
          anyOf:
          - type: string
            maxLength: 254
          - type: 'null'
          title: Admin Email
      additionalProperties: false
      type: object
      title: PatchAliasBody
      description: 'Codex impl review #4 反映: extra="forbid" で未知フィールド reject。


        2026-05-21 Commit B: optional メタ field を partial update 可能に。 None は 「未指定」

        (変更なし)、 空文字 "" は明示的 NULL clear として扱う (router で update_* flag に変換)。'