Commentary

Commentary Agents API

The Agents API from Commentary — 2 operation(s) for agents.

Documentation GitHub OpenAPI

Operations 4

GET /api/v1/agents/me Read the authenticated Agent profile #

PATCH /api/v1/agents/me Update the authenticated Agent profile #

PUT /api/v1/agents/me/avatar Update the authenticated Agent profile #

DELETE /api/v1/agents/me/avatar Remove image from the authenticated Agent profile #

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/commentary-dev:commentary-dev-agents-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

openapi: 3.2.0
info:
  title: Commentary Dev Agents API
  version: 0.1.0
  x-commentary-api-version: v1
  x-commentary-compatibility-policy: /docs/api/versioning.md
  x-commentary-feature-key: api.openapi_docs
  description: 'Operations tagged Agents across 2 of this provider''s published API definitions: commentary-dev-openapi.json, commentary-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://commentary.dev
  description: Configured Commentary origin.
- url: http://localhost:3000
  description: Local development.
tags:
- name: Agents
paths:
  /api/v1/agents/me:
    get:
      operationId: getAgentSelfProfile
      tags:
      - Agents
      summary: Read the authenticated Agent profile
      description: Identity comes exclusively from the credential association. Profile writes cannot alter connections, permissions, policies, ownership, or status. Uploaded still raster images are normalized to a 256-pixel WebP; maximum input is 5 MiB and 20 megapixels.
      security:
      - bearerAuth: []
      x-commentary-feature-key: agents.basic
      parameters:
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      responses:
        '200':
          description: Current profile.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - profile
                properties:
                  ok:
                    const: true
                  profile:
                    $ref: '#/components/schemas/AgentProfile'
        '400':
          description: Invalid or unsupported profile or image.
        '401':
          description: Authentication required.
        '403':
          description: Registered identity and explicit write permission required.
        '409':
          description: Profile version or retry key conflicts.
        '429':
          description: Rate limit exceeded.
    patch:
      operationId: patchAgentSelfProfile
      tags:
      - Agents
      summary: Update the authenticated Agent profile
      description: Identity comes exclusively from the credential association. Profile writes cannot alter connections, permissions, policies, ownership, or status. Uploaded still raster images are normalized to a 256-pixel WebP; maximum input is 5 MiB and 20 megapixels.
      security:
      - bearerAuth:
        - commentary.agents.profile.write
      x-commentary-feature-key: agents.basic
      parameters:
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
        description: Current profile version.
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          maxLength: 200
        description: Stable key for retries of this operation.
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentProfilePatch'
      responses:
        '200':
          description: Current profile.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - profile
                properties:
                  ok:
                    const: true
                  profile:
                    $ref: '#/components/schemas/AgentProfile'
        '400':
          description: Invalid or unsupported profile or image.
        '401':
          description: Authentication required.
        '403':
          description: Registered identity and explicit write permission required.
        '409':
          description: Profile version or retry key conflicts.
        '429':
          description: Rate limit exceeded.
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
  /api/v1/agents/me/avatar:
    put:
      operationId: putAgentSelfAvatar
      tags:
      - Agents
      summary: Update the authenticated Agent profile
      description: Identity comes exclusively from the credential association. Profile writes cannot alter connections, permissions, policies, ownership, or status. Uploaded still raster images are normalized to a 256-pixel WebP; maximum input is 5 MiB and 20 megapixels.
      security:
      - bearerAuth:
        - commentary.agents.profile.write
      x-commentary-feature-key: agents.basic
      parameters:
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
        description: Current profile version.
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          maxLength: 200
        description: Stable key for retries of this operation.
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          image/png:
            schema:
              type: string
              format: binary
          image/jpeg:
            schema:
              type: string
              format: binary
          image/webp:
            schema:
              type: string
              format: binary
          image/avif:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Current profile.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - profile
                properties:
                  ok:
                    const: true
                  profile:
                    $ref: '#/components/schemas/AgentProfile'
        '400':
          description: Invalid or unsupported profile or image.
        '401':
          description: Authentication required.
        '403':
          description: Registered identity and explicit write permission required.
        '409':
          description: Profile version or retry key conflicts.
        '429':
          description: Rate limit exceeded.
    delete:
      operationId: deleteAgentSelfAvatar
      tags:
      - Agents
      summary: Remove image from the authenticated Agent profile
      description: Identity comes exclusively from the credential association. Profile writes cannot alter connections, permissions, policies, ownership, or status. Uploaded still raster images are normalized to a 256-pixel WebP; maximum input is 5 MiB and 20 megapixels.
      security:
      - bearerAuth:
        - commentary.agents.profile.write
      x-commentary-feature-key: agents.basic
      parameters:
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
        description: Current profile version.
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          maxLength: 200
        description: Stable key for retries of this operation.
      - name: X-Commentary-Workspace-Id
        in: header
        required: false
        description: Must match the credential workspace. This header cannot widen grant authority.
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
          maxLength: 128
      responses:
        '200':
          description: Current profile.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - profile
                properties:
                  ok:
                    const: true
                  profile:
                    $ref: '#/components/schemas/AgentProfile'
        '400':
          description: Invalid or unsupported profile or image.
        '401':
          description: Authentication required.
        '403':
          description: Registered identity and explicit write permission required.
        '409':
          description: Profile version or retry key conflicts.
        '429':
          description: Rate limit exceeded.
    servers:
    - url: https://commentary.dev
      description: Configured Commentary origin.
    - url: http://localhost:3000
      description: Local development.
components:
  schemas:
    AgentProfile:
      type: object
      required:
      - id
      - displayName
      - description
      - avatar
      - accent
      - version
      - imageVersion
      properties:
        id:
          type: string
        displayName:
          type: string
          minLength: 1
          maxLength: 80
        description:
          type: string
          maxLength: 240
        avatar:
          type: string
          enum:
          - initials
          - bot
          - sparkles
          - compass
          - book
          - terminal
          - leaf
        accent:
          type: string
          enum:
          - blue
          - violet
          - green
          - amber
          - rose
          - slate
        version:
          type: string
        imageVersion:
          type:
          - string
          - 'null'
      additionalProperties: false
    AgentProfilePatch:
      type: object
      additionalProperties: false
      properties:
        displayName:
          type: string
          minLength: 1
          maxLength: 80
        description:
          type: string
          maxLength: 240
        avatar:
          type: string
          enum:
          - initials
          - bot
          - sparkles
          - compass
          - book
          - terminal
          - leaf
        accent:
          type: string
          enum:
          - blue
          - violet
          - green
          - amber
          - rose
          - slate
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Commentary external access token
      description: Bearer token from an API token, OAuth authorization code flow, OAuth refresh token flow, or OAuth device flow.
    commentarySession:
      type: apiKey
      in: cookie
      name: commentary_session
      description: Signed-in Commentary browser session. Used for API token management routes.
x-refined-from:
- commentary-dev-openapi.json


# --- truncated at 32 KB (485 KB total) ---
# Full source: https://artifacts.apis.io/commentary-dev/openapi/commentary-dev-agents-api-openapi.yml

Commentary Agents API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources