Portkey Configs API

openapi: 3.0.0
info:
  title: Portkey Analytics > Graphs Configs API
  description: The Portkey REST API. Please see https://portkey.ai/docs/api-reference for more details.
  version: 2.0.0
  termsOfService: https://portkey.ai/terms
  contact:
    name: Portkey Developer Forum
    url: https://portkey.wiki/community
  license:
    name: MIT
    url: https://github.com/Portkey-AI/portkey-openapi/blob/master/LICENSE
servers:
- url: https://api.portkey.ai/v1
  description: Portkey API Public Endpoint
security:
- Portkey-Key: []
tags:
- name: Configs
  description: Create, List, Retrieve, and Update your Portkey Configs.
paths:
  /configs:
    servers:
    - url: https://api.portkey.ai/v1
      description: Portkey API Public Endpoint
    - url: SELF_HOSTED_CONTROL_PLANE_URL
      description: Self-Hosted Control Plane URL
    get:
      summary: List all configs
      tags:
      - Configs
      operationId: listConfigs
      responses:
        '200':
          description: A list of configs
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        slug:
                          type: string
                        organisation_id:
                          type: string
                          format: uuid
                        workspace_id:
                          type: string
                          format: uuid
                        is_default:
                          type: integer
                        status:
                          type: string
                        owner_id:
                          type: string
                          format: uuid
                        updated_by:
                          type: string
                          format: uuid
                        created_at:
                          type: string
                          format: date-time
                        last_updated_at:
                          type: string
                          format: date-time
              examples:
                example-1:
                  value:
                    success: true
                    data:
                    - id: 4e54a1a4-109c-43ee-b0f7-11e7d60b0066
                      name: Pplx Cache Test
                      slug: pc-pplx-c-ca7a87
                      organisation_id: 472d2804-d054-4226-b4ae-9d4e2e61e69e
                      workspace_id: 472d2804-d054-4226-b4ae-9d4e2e61e69e
                      is_default: 0
                      status: active
                      owner_id: c4c7996d-be62-429d-b787-5d48fe94da86
                      updated_by: 439268ba-94a2-4031-9ca7-ca88ddda5096
                      created_at: '2024-05-12T21:37:06.000Z'
                      last_updated_at: '2024-05-23T23:36:06.000Z'
      x-code-samples:
      - lang: python
        label: Default
        source: "from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n)\n\n# Retrieve the configuration\nconfig = portkey.configs.list(\n    workspace_id=\"WORKSPACE_ID\"\n)\n\nprint(config)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n})\n\nconst config=await portkey.configs.list({\n    workspace_id:\"WORKSPACE_ID\"\n})\nconsole.log(config);\n"
      - lang: python
        label: Self-Hosted
        source: "from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n    base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\n# Retrieve the configuration\nconfig = portkey.configs.list(\n    workspace_id=\"WORKSPACE_ID\"\n)\n\nprint(config)\n"
      - lang: javascript
        label: Self-Hosted
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n    baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nconst config=await portkey.configs.list({\n    workspace_id:\"WORKSPACE_ID\"\n})\nconsole.log(config);\n"
    post:
      summary: Create a config
      tags:
      - Configs
      operationId: createConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                config:
                  type: object
                isDefault:
                  type: integer
                workspace_id:
                  type: string
                  format: uuid
                  description: optional, when using organisation admin API keys
            examples:
              example-1:
                value:
                  name: New config
                  config:
                    retry:
                      attempts: 3
                  workspace_id: ''
                  isDefault: 1
      responses:
        '200':
          description: Config created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      version_id:
                        type: string
                        format: uuid
              examples:
                example-1:
                  value:
                    success: true
                    data:
                      id: f3d8d070-f29d-43a3-bf97-3159c60f4ce0
                      version_id: 0db4065b-ead2-4daa-bf5e-7e9106585133
      x-code-samples:
      - lang: python
        label: Default
        source: "from portkey_ai import Portkey\n\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n)\n\n# Create a new configuration\nconfig = portkey.configs.create(\n    name=\"ConfigName_0909\",\n    config={\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"simple\"\n        }\n    },\n    workspace_id=\"WORKSPACE_ID\",\n)\n\nprint(config)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n})\n\nconst config=await portkey.configs.create({\n    name:\"ConfigName_0909\",\n    config:{\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"simple\"\n        }\n    },\n    workspace_id:\"WORKSPACE_ID\"\n})\n\nconsole.log(config);\n"
      - lang: python
        label: Self-Hosted
        source: "from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n    base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\n# Create a new configuration\nconfig = portkey.configs.create(\n    name=\"ConfigName_0909\",\n    config={\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"simple\"\n        }\n    },\n    workspace_id=\"WORKSPACE_ID\",\n)\n\nprint(config)\n"
      - lang: javascript
        label: Self-Hosted
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n    baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nconst config=await portkey.configs.create({\n    name:\"ConfigName_0909\",\n    config:{\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"simple\"\n        }\n    },\n    workspace_id:\"WORKSPACE_ID\"\n})\n\nconsole.log(config);\n"
  /configs/{slug}:
    servers:
    - url: https://api.portkey.ai/v1
      description: Portkey API Public Endpoint
    - url: SELF_HOSTED_CONTROL_PLANE_URL
      description: Self-Hosted Control Plane URL
    delete:
      summary: Delete a config
      tags:
      - Configs
      operationId: deleteConfig
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Config deleted successfully
          content:
            application/json:
              schema:
                type: object
              examples:
                example-1:
                  value: {}
      x-code-samples:
      - lang: python
        label: Default
        source: "portkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n)\n\nportkey.configs.delete(\n    id=\"CONFIG_SLUG\"\n)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n})\n\nawait portkey.configs.delete({\n    id:\"CONFIG_SLUG\"\n})\n"
      - lang: python
        label: Self-Hosted
        source: "from portkey_ai import Portkey\n\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n    base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\nportkey.configs.delete(\n    id=\"CONFIG_SLUG\"\n)\n"
      - lang: javascript
        label: Self-Hosted
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n    baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nawait portkey.configs.delete({\n    id:\"CONFIG_SLUG\"\n})\n"
    get:
      servers:
      - url: https://api.portkey.ai/v1
        description: Portkey API Public Endpoint
      - url: SELF_HOSTED_CONTROL_PLANE_URL
        description: Self-Hosted Control Plane URL
      summary: Get a config
      tags:
      - Configs
      operationId: getConfig
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Config details
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      config:
                        type: object
                        properties:
                          retry:
                            type: object
                            properties:
                              attempts:
                                type: integer
                              on_status_codes:
                                type: array
                                items:
                                  type: integer
                          cache:
                            type: object
                            properties:
                              mode:
                                type: string
                              max_age:
                                type: integer
                          strategy:
                            type: object
                            properties:
                              mode:
                                type: string
                          targets:
                            type: array
                            items:
                              type: object
                              properties:
                                provider:
                                  type: string
                                virtual_key:
                                  type: string
              examples:
                example-1:
                  value:
                    success: true
                    data:
                      config:
                        retry:
                          attempts: 5
                          on_status_codes:
                          - 429
                          - 529
                        cache:
                          mode: simple
                          max_age: 3600
                        strategy:
                          mode: fallback
                        targets:
                        - provider: openai
                          virtual_key: main-258f4d
                        - provider: azure-openai
                          virtual_key: azure-test-4110dd
      x-code-samples:
      - lang: python
        label: Default
        source: "from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n)\n\n# Retrieve the configuration\nconfig = portkey.configs.retrieve(\n    slug='CONFIG_SLUG'\n)\n\nprint(config)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n})\n\nconst config=await portkey.configs.retrieve({\n    slug:'CONFIG_SLUG'\n})\n\nconsole.log(config);\n"
      - lang: python
        label: Self-Hosted
        source: "from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n    base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\n# Retrieve the configuration\nconfig = portkey.configs.retrieve(\n    slug='CONFIG_SLUG'\n)\n\nprint(config)\n"
      - lang: javascript
        label: Self-Hosted
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n    baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nconst config=await portkey.configs.retrieve({\n    slug:'CONFIG_SLUG'\n})\n\nconsole.log(config);\n"
    put:
      servers:
      - url: https://api.portkey.ai/v1
        description: Portkey API Public Endpoint
      - url: SELF_HOSTED_CONTROL_PLANE_URL
        description: Self-Hosted Control Plane URL
      summary: Update a config
      tags:
      - Configs
      operationId: updateConfig
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                config:
                  type: object
                  properties:
                    virtual_key:
                      type: string
                status:
                  type: string
            examples:
              example-1:
                value:
                  name: testConf
                  config:
                    virtual_key: copy-of-anthrop-b20259
                  status: active
      responses:
        '200':
          description: Config updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      version_id:
                        type: string
                        format: uuid
              examples:
                example-1:
                  value:
                    success: true
                    data:
                      version_id: abe447e2-f6aa-4229-93b7-8ee3183b6667
      x-code-samples:
      - lang: python
        label: Default
        source: "portkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n)\n\n# Update the configuration\nupdated_config = portkey.configs.update(\n    slug=\"CONFIG_SLUG\",\n    name=\"Updated Config\",\n    config={\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"semantic\"\n        }\n    }\n)\nprint(updated_config)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n})\n\nconst config=await portkey.configs.update({\n    slug:\"CONFIG_SLUG\",\n    name:\"Updated Config\",\n    config:{\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"semantic\"\n        }\n    },\n\n})\n\nconsole.log(config);\n"
      - lang: python
        label: Self-Hosted
        source: "from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n    api_key=\"PORTKEY_API_KEY\",\n    base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\n# Update the configuration\nupdated_config = portkey.configs.update(\n    slug=\"CONFIG_SLUG\",\n    name=\"Updated Config\",\n    config={\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"semantic\"\n        }\n    }\n)\nprint(updated_config)\n"
      - lang: javascript
        label: Self-Hosted
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey:\"PORTKEY_API_KEY\",\n    baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nconst config=await portkey.configs.update({\n    slug:\"CONFIG_SLUG\",\n    name:\"Updated Config\",\n    config:{\n        \"retry\": {\n            \"attempts\": 3\n        },\n        \"cache\": {\n            \"mode\": \"semantic\"\n        }\n    },\n\n})\n\nconsole.log(config);\n"
  /configs/{slug}/versions:
    servers:
    - url: https://api.portkey.ai/v1
      description: Portkey API Public Endpoint
    - url: SELF_HOSTED_CONTROL_PLANE_URL
      description: Self-Hosted Control Plane URL
    get:
      summary: List versions for a config
      tags:
      - Configs
      operationId: listConfigVersions
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of config versions
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        workspace_id:
                          type: string
                          format: uuid
                        slug:
                          type: string
                        organisation_id:
                          type: string
                          format: uuid
                        is_default:
                          type: integer
                        status:
                          type: string
                        owner_id:
                          type: string
                          format: uuid
                        updated_by:
                          type: string
                          format: uuid
                        created_at:
                          type: string
                          format: date-time
                        last_updated_at:
                          type: string
                          format: date-time
                        config:
                          type: string
                          description: Serialized configuration for this version
                        format:
                          type: string
                        type:
                          type: string
                        version_id:
                          type: string
                          format: uuid
                        object:
                          type: string
              examples:
                example-1:
                  value:
                    object: list
                    total: 1
                    data:
                    - id: daab995b-8d3b-42c5-a490-47217fbf4e0e
                      name: PII Redaction Guardrail
                      workspace_id: 8610029e-692a-4df6-9052-3fa3eff69911
                      slug: pc-pii-re-7f1051
                      organisation_id: 472d2804-d054-4226-b4ae-9d4e2e61e69e
                      is_default: 0
                      status: active
                      owner_id: c4c7996d-be62-429d-b787-5d48fe94da86
                      updated_by: c4c7996d-be62-429d-b787-5d48fe94da86
                      created_at: '2025-10-17T19:11:47.000Z'
                      last_updated_at: '2025-10-17T19:11:47.000Z'
                      config: '{"input_guardrails":["pg-patron-1d0224"]}'
                      format: json
                      type: ORG_CONFIG
                      version_id: 8c1a4fbf-26d9-49df-82ca-ab772ba397d2
                      object: config
      x-code-samples:
      - lang: curl
        label: Default
        source: 'curl --location ''https://api.portkey.ai/v1/configs/pc-pii-re-7f1051/versions'' \

          --header ''x-portkey-api-key: PORTKEY_API_KEY''

          '
components:
  securitySchemes:
    Portkey-Key:
      type: apiKey
      in: header
      name: x-portkey-api-key
    Virtual-Key:
      type: apiKey
      in: header
      name: x-portkey-virtual-key
    Provider-Auth:
      type: http
      scheme: bearer
    Provider-Name:
      type: apiKey
      in: header
      name: x-portkey-provider
    Config:
      type: apiKey
      in: header
      name: x-portkey-config
    Custom-Host:
      type: apiKey
      in: header
      name: x-portkey-custom-host
x-server-groups:
  ControlPlaneServers:
  - url: https://api.portkey.ai/v1
    description: Portkey API Public Endpoint
  - url: SELF_HOSTED_CONTROL_PLANE_URL
    description: Self-Hosted Control Plane URL
  DataPlaneServers:
  - url: https://api.portkey.ai/v1
    description: Portkey API Public Endpoint
  - url: SELF_HOSTED_GATEWAY_URL
    description: Self-Hosted Gateway URL
  PublicServers:
  - url: https://api.portkey.ai
    description: Portkey Public API (no auth required)
x-mint:
  mcp:
    enabled: true
    name: Portkey MCP
    description: Official MCP Server for Portkey Docs & APIs
x-code-samples:
  navigationGroups:
  - id: endpoints
    title: Endpoints
  - id: assistants
    title: Assistants
  - id: legacy
    title: Legacy
  groups:
  - id: audio
    title: Audio
    description: 'Learn how to turn audio into text or text into audio.


      Related guide: [Speech to text](https://platform.openai.com/docs/guides/speech-to-text)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createSpeech
      path: createSpeech
    - type: endpoint
      key: createTranscription
      path: createTranscription
    - type: endpoint
      key: createTranslation
      path: createTranslation
    - type: object
      key: CreateTranscriptionResponseJson
      path: json-object
    - type: object
      key: CreateTranscriptionResponseVerboseJson
      path: verbose-json-object
  - id: chat
    title: Chat
    description: 'Given a list of messages comprising a conversation, the model will return a response.


      Related guide: [Chat Completions](https://platform.openai.com/docs/guides/text-generation)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createChatCompletion
      path: create
    - type: object
      key: CreateChatCompletionResponse
      path: object
    - type: object
      key: CreateChatCompletionStreamResponse
      path: streaming
  - id: realtime
    title: Realtime
    description: 'WebSocket proxy for provider Realtime APIs (`GET` upgrade). Use `wss://` with the same `/v1` data-plane base as other gateway routes.


      Related guide: [OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: connectRealtime
      path: connect
  - id: embeddings
    title: Embeddings
    description: 'Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.


      Related guide: [Embeddings](https://platform.openai.com/docs/guides/embeddings)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createEmbedding
      path: create
    - type: object
      key: Embedding
      path: object
  - id: rerank
    title: Rerank
    description: 'Rerank a list of documents based on their relevance to a query. Reranking improves search results by scoring documents based on semantic relevance rather than keyword matching.


      Supported providers: Cohere, Voyage, Jina, Pinecone, Bedrock, Azure AI.

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createRerank
      path: create
    - type: object
      key: CreateRerankResponse
      path: object
  - id: fine-tuning
    title: Fine-tuning
    description: 'Manage fine-tuning jobs to tailor a model to your specific training data.


      Related guide: [Fine-tune models](https://platform.openai.com/docs/guides/fine-tuning)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createFineTuningJob
      path: create
    - type: endpoint
      key: listPaginatedFineTuningJobs
      path: list
    - type: endpoint
      key: listFineTuningEvents
      path: list-events
    - type: endpoint
      key: listFineTuningJobCheckpoints
      path: list-checkpoints
    - type: endpoint
      key: retrieveFineTuningJob
      path: retrieve
    - type: endpoint
      key: cancelFineTuningJob
      path: cancel
    - type: object
      key: FinetuneChatRequestInput
      path: chat-input
    - type: object
      key: FinetuneCompletionRequestInput
      path: completions-input
    - type: object
      key: FineTuningJob
      path: object
    - type: object
      key: FineTuningJobEvent
      path: event-object
    - type: object
      key: FineTuningJobCheckpoint
      path: checkpoint-object
  - id: batch
    title: Batch
    description: 'Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount.


      Related guide: [Batch](https://platform.openai.com/docs/guides/batch)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createBatch
      path: create
    - type: endpoint
      key: retrieveBatch
      path: retrieve
    - type: endpoint
      key: cancelBatch
      path: cancel
    - type: endpoint
      key: listBatches
      path: list
    - type: object
      key: Batch
      path: object
    - type: object
      key: BatchRequestInput
      path: request-input
    - type: object
      key: BatchRequestOutput
      path: request-output
  - id: files
    title: Files
    description: 'Files are used to upload documents that can be used with features like [Assistants](https://platform.openai.com/docs/api-reference/assistants), [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning), and [Batch API](https://platform.openai.com/docs/guides/batch).

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createFile
      path: create
    - type: endpoint
      key: listFiles
      path: list
    - type: endpoint
      key: retrieveFile
      path: retrieve
    - type: endpoint
      key: deleteFile
      path: delete
    - type: endpoint
      key: downloadFile
      path: retrieve-contents
    - type: object
      key: OpenAIFile
      path: object
  - id: images
    title: Images
    description: 'Given a prompt and/or an input image, the model will generate a new image.


      Related guide: [Image generation](https://platform.openai.com/docs/guides/images)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createImage
      path: create
    - type: endpoint
      key: createImageEdit
      path: createEdit
    - type: endpoint
      key: createImageVariation
      path: createVariation
    - type: object
      key: Image
      path: object
  - id: models
    title: Models
    description: 'List and describe the various models available in the API. You can refer to the [Models](https://platform.openai.com/docs/models) documentation to understand what models are available and the differences between them.

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: listModels
      path: list
    - type: endpoint
      key: retrieveModel
      path: retrieve
    - type: endpoint
      key: deleteModel
      path: delete
    - type: object
      key: Model
      path: object
  - id: moderations
    title: Moderations
    description: 'Given some input text, outputs if the model classifies it as potentially harmful across several categories.


      Related guide: [Moderations](https://platform.openai.com/docs/guides/moderation)

      '
    navigationGroup: endpoints
    sections:
    - type: endpoint
      key: createModeration
      path: create
    - type: object
      key: CreateModerationResponse
      path: object
  - id: assistants
    title: Assistants
    beta: true
    description: 'Build assistants that can call models and use tools to perform tasks.


      [Get started with the Assistants API](https://platform.openai.com/docs/assistants)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createAssistant
      path: createAssistant
    - type: endpoint
      key: listAssistants
      path: listAssistants
    - type: endpoint
      key: getAssistant
      path: getAssistant
    - type: endpoint
      key: modifyAssistant
      path: modifyAssistant
    - type: endpoint
      key: deleteAssistant
      path: deleteAssistant
    - type: object
      key: AssistantObject
      path: object
  - id: threads
    title: Threads
    beta: true
    description: 'Create threads that assistants can interact with.


      Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createThread
      path: createThread
    - type: endpoint
      key: getThread
      path: getThread
    - type: endpoint
      key: modifyThread
      path: modifyThread
    - type: endpoint
      key: deleteThread
      path: deleteThread
    - type: object
      key: ThreadObject
      path: object
  - id: messages
    title: Messages
    beta: true
    description: 'Create messages within threads


      Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createMessage
      path: createMessage
    - type: endpoint
      key: listMessages
      path: listMessages
    - type: endpoint
      key: getMessage
      path: getMessage
    - type: endpoint
      key: modifyMessage
      path: modifyMessage
    - type: endpoint
      key: deleteMessage
      path: deleteMessage
    - type: object
      key: MessageObject
      path: object
  - id: runs
    title: Runs
    beta: true
    description: 'Represents an execution run on a thread.


      Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createRun
      path: createRun
    - type: endpoint
      key: createThreadAndRun
      path: createThreadAndRun
    - type: endpoint
      key: listRuns
      path: listRuns
    - type: endpoint
      key: getRun
      path: getRun
    - type: endpoint
      key: modifyRun
      path: modifyRun
    - type: endpoint
      key: submitToolOuputsToRun
      path: submitToolOutputs
    - type: endpoint
      key: cancelRun
      path: cancelRun
    - type: object
      key: RunObject
      path: object
  - id: run-steps
    title: Run Steps
    beta: true
    description: 'Represents the steps (model and tool calls) taken during the run.


      Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: listRunSteps
      path: listRunSteps
    - type: endpoint
      key: g

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/portkey/refs/heads/main/openapi/portkey-configs-api-openapi.yml