> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentkey.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Describe a method

> Describe a scenario method



## OpenAPI

````yaml api-reference/openapi/v2.yaml GET /v2/ops/{op}
openapi: 3.1.0
info:
  description: >-
    Fixed, versioned, provider-independent methods over AgentKey's upstream
    catalog. Each method has a stable name, input schema and output schema; the
    server picks the upstream provider, fails over, normalizes fields and
    refunds failed attempts. Every response names the provider that served it,
    the credits charged and every attempt made.
  title: AgentKey Scenario Methods
  version: '2'
servers:
  - url: https://api.agentkey.app
security: []
paths:
  /v2/ops/{op}:
    get:
      tags:
        - catalog
      summary: Describe a scenario method
      description: >-
        Input/output schemas, bindings with list prices and live health,
        unsupported fields and examples. No authentication required.
      operationId: describeOp
      parameters:
        - in: path
          name: op
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodDescription'
          description: Method description
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unknown method
components:
  schemas:
    MethodDescription:
      description: >-
        Full description of a method: schemas, bindings with live health and
        list prices, unsupported fields, per-provider examples (examples are
        served here, not in this document).
      properties:
        bindings:
          items:
            type: object
          type: array
        input_schema:
          type: object
        name:
          description: Method name.
          type: string
        output_schema:
          type: object
        price_credits:
          type: number
        reserved_params:
          type: object
        strategies:
          description: routing.strategy values this server accepts.
          items:
            type: string
          type: array
        tier:
          description: beta | stable | deprecated
          type: string
        version:
          type: integer
      type: object
    ErrorEnvelope:
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        code:
          type: integer
        error:
          description: Human-readable message.
          type: string
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout | insufficient_credits
            | upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        op:
          description: Method name.
          type: string
        request_id:
          description: Correlation id.
          type: string
      required:
        - error
        - code
        - error_type
      type: object
    Attempt:
      description: >-
        One upstream try. Present on success and failure so a failover is never
        invisible.
      properties:
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout |
            upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        provider:
          description: Provider slug.
          type: string
        refunded:
          description: true when the reservation for this attempt was refunded.
          type: boolean
        status:
          description: HTTP status AgentKey mapped this attempt to (200 on success).
          type: integer
        took_ms:
          type: integer
        tool:
          description: Registry tool name (Provider/operation) that was called.
          type: string
        upstream_status:
          description: The provider's real HTTP status; absent when nothing was received.
          type: integer
      required:
        - provider
        - tool
        - status
        - took_ms
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.