Helicone Vault API

openapi: 3.0.0
info:
  title: helicone-api Agent Vault API
  version: 1.0.0
  license:
    name: MIT
  contact: {}
servers:
- url: https://api.helicone.ai/
- url: http://localhost:8585/
tags:
- name: Vault
paths:
  /v1/vault/add:
    post:
      operationId: AddKey
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result__id-string_.string_'
      tags:
      - Vault
      security:
      - api_key: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddVaultKeyParams'
  /v1/vault/keys:
    get:
      operationId: GetKeys
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_DecryptedProviderKey-Array.string_'
      tags:
      - Vault
      security:
      - api_key: []
      parameters: []
  /v1/vault/key/{providerKeyId}:
    get:
      operationId: GetKeyById
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_DecryptedProviderKey.string_'
      tags:
      - Vault
      security:
      - api_key: []
      parameters:
      - in: path
        name: providerKeyId
        required: true
        schema:
          type: string
  /v1/vault/update/{id}:
    patch:
      operationId: UpdateKey
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_null.string_'
      tags:
      - Vault
      security:
      - api_key: []
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                active:
                  type: boolean
                name:
                  type: string
                key:
                  type: string
              type: object
components:
  schemas:
    Result__id-string_.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess__id-string__'
      - $ref: '#/components/schemas/ResultError_string_'
    ResultSuccess_DecryptedProviderKey-Array_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/DecryptedProviderKey'
          type: array
        error:
          type: number
          enum:
          - null
          nullable: true
      required:
      - data
      - error
      type: object
      additionalProperties: false
    AddVaultKeyParams:
      properties:
        key:
          type: string
        provider:
          type: string
        name:
          type: string
      required:
      - key
      - provider
      type: object
      additionalProperties: false
    ResultSuccess__id-string__:
      properties:
        data:
          properties:
            id:
              type: string
          required:
          - id
          type: object
        error:
          type: number
          enum:
          - null
          nullable: true
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ResultSuccess_DecryptedProviderKey_:
      properties:
        data:
          $ref: '#/components/schemas/DecryptedProviderKey'
        error:
          type: number
          enum:
          - null
          nullable: true
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ResultSuccess_null_:
      properties:
        data:
          type: number
          enum:
          - null
          nullable: true
        error:
          type: number
          enum:
          - null
          nullable: true
      required:
      - data
      - error
      type: object
      additionalProperties: false
    DecryptedProviderKey:
      properties:
        cuid:
          type: string
          nullable: true
        provider_secret_key:
          type: string
          nullable: true
        provider_key_name:
          type: string
          nullable: true
        provider_name:
          type: string
          nullable: true
        provider_key:
          type: string
          nullable: true
        org_id:
          type: string
          nullable: true
        id:
          type: string
          nullable: true
      required:
      - provider_secret_key
      - provider_key_name
      - provider_name
      - provider_key
      - org_id
      - id
      type: object
    Result_null.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_null_'
      - $ref: '#/components/schemas/ResultError_string_'
    Result_DecryptedProviderKey-Array.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_DecryptedProviderKey-Array_'
      - $ref: '#/components/schemas/ResultError_string_'
    ResultError_string_:
      properties:
        data:
          type: number
          enum:
          - null
          nullable: true
        error:
          type: string
      required:
      - data
      - error
      type: object
      additionalProperties: false
    Result_DecryptedProviderKey.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_DecryptedProviderKey_'
      - $ref: '#/components/schemas/ResultError_string_'
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
      description: 'Bearer token authentication. Format: ''Bearer YOUR_API_KEY'''