Portkey

Portkey User-invites API

Create and manage user invites.

GitHub OpenAPI

Documentation

📖
Documentation
https://portkey.ai/docs/introduction/what-is-portkey
📖
APIReference
https://portkey.ai/docs/api-reference/inference-api/chat
📖
GettingStarted
https://portkey.ai/docs/guides/getting-started/getting-started-with-ai-gateway
📖
APIReference
https://portkey.ai/docs/api-reference/inference-api/completions
📖
APIReference
https://portkey.ai/docs/api-reference/inference-api/embeddings
📖
APIReference
https://portkey.ai/docs/api-reference/admin-api/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/portkey/refs/heads/main/openapi/portkey-user-invites-api-openapi.yml

OpenAPI Specification

portkey-user-invites-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  title: Portkey Analytics > Graphs User-invites 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: User-invites
  description: Create and manage user invites.
paths:
  /admin/users/invites:
    servers:
    - url: https://api.portkey.ai/v1
      description: Portkey API Public Endpoint
    - url: SELF_HOSTED_CONTROL_PLANE_URL
      description: Self-Hosted Control Plane URL
    post:
      operationId: Invites_create
      summary: Invite User
      description: Send an invite to user for your organization
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessInvite'
      tags:
      - User-invites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvite'
      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# Add a user invite\nuser = portkey.admin.users.invites.create(\n    email=\"user@example.com\",\n    role=\"member\",\n    workspaces=[\n        {\n            \"id\": \"WORKSPACE_SLUG\",\n            \"role\": \"admin\"\n        }\n    ],\n    workspace_api_key_details={\n        \"scopes\": [\n            \"workspaces.list\",\n            \"logs.export\",\n            \"logs.list\",\n            \"logs.view\",\n        ]\n    }\n)\n\nprint(user)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst user=await portkey.admin.users.invites.create({\n    email:\"user@example.com\",\n    role: \"member\",\n    workspaces: [\n    {\n    id:\"WORKSPACE_SLUG\",\n    role:\"admin\"\n    }],\n    workspace_api_key_details:{\n        scopes: [\n        \"workspaces.list\",\n        \"logs.export\",\n        \"logs.list\",\n        \"logs.view\",\n    ]\n    }\n})\n\nconsole.log(user);\n"
      - lang: curl
        label: Default
        source: "curl -X POST https://api.portkey.ai/v1/admin/users/invites\n-H \"x-portkey-api-key: PORTKEY_API_KEY\"\n-H \"Content-Type: application/json\"\n-d '{\n    \"email\": \"user@example.com\",\n    \"role\": \"member\",\n    \"workspaces\": [\n        {\n            \"id\": \"WORKSPACE_SLUG\",\n            \"role\": \"admin\"\n        }\n    ],\n    \"workspace_api_key_details\": {\n        \"scopes\": [\n            \"workspaces.list\",\n            \"logs.export\",\n            \"logs.list\",\n            \"logs.view\"\n        ]\n    }\n}'\n"
      - lang: curl
        label: Self-Hosted
        source: "curl -X POST SELF_HOSTED_CONTROL_PLANE_URL/admin/users/invites\n-H \"x-portkey-api-key: PORTKEY_API_KEY\"\n-H \"Content-Type: application/json\"\n-d '{\n    \"email\": \"user@example.com\",\n    \"role\": \"member\",\n    \"workspaces\": [\n        {\n            \"id\": \"WORKSPACE_SLUG\",\n            \"role\": \"admin\"\n        }\n    ],\n    \"workspace_api_key_details\": {\n        \"scopes\": [\n            \"workspaces.list\",\n            \"logs.export\",\n            \"logs.list\",\n            \"logs.view\"\n        ]\n    }\n}'\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# Add a user invite\nuser = portkey.admin.users.invites.create(\n    email=\"user@example.com\",\n    role=\"member\",\n    workspaces=[\n        {\n            \"id\": \"WORKSPACE_SLUG\",\n            \"role\": \"admin\"\n        }\n    ],\n    workspace_api_key_details={\n        \"scopes\": [\n            \"workspaces.list\",\n            \"logs.export\",\n            \"logs.list\",\n            \"logs.view\",\n        ]\n    }\n)\n\nprint(user)\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 user = await portkey.admin.users.invites.create({\n    email: \"user@example.com\",\n    role: \"member\",\n    workspaces: [\n        {\n            id: \"WORKSPACE_SLUG\",\n            role: \"admin\"\n        }\n    ],\n    workspace_api_key_details: {\n        scopes: [\n            \"workspaces.list\",\n            \"logs.export\",\n            \"logs.list\",\n            \"logs.view\",\n        ]\n    }\n})\n\nconsole.log(user);\n"
    get:
      tags:
      - User-invites
      summary: Get All Invites
      parameters:
      - name: pageSize
        in: query
        schema:
          type: integer
        example: '1'
      - name: currentPage
        in: query
        schema:
          type: integer
        example: '0'
      - name: role
        in: query
        schema:
          type: string
          enum:
          - admin
          - member
        example: admin
      - name: email
        in: query
        schema:
          type: string
          format: email
        example: foo@bar.com
      - name: status
        in: query
        schema:
          type: string
          enum:
          - pending
          - cancelled
          - accepted
          - expired
        example: pending
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteList'
              example:
                object: list
                total: 2
                data:
                - object: invite
                  id: 419641fb-1458-47d6-94d0-e308159b3ec2
                  email: horace.slughorn@example.com
                  role: member
                  created_at: '2023-12-12 13:56:32'
                  expires_at: '2023-12-12 13:56:32'
                  accepted_at: '2023-12-12 13:56:32'
                  status: pending
                  invited_by: a90e74fb-269e-457b-8b59-9426cdd8907e
                  workspaces:
                  - workspace_id: ''
                    role: ''
      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# List user invites\nuser_invites = portkey.admin.users.invites.list(\n    email=\"user@example.com\"\n)\n\nprint(user_invites)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst user=await portkey.admin.users.invites.list({\n    email:\"user@example.com\"\n});\nconsole.log(user);\n"
      - lang: curl
        label: Default
        source: "curl -X GET \"https://api.portkey.ai/v1/admin/users/invites?email=user@example.com\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"
      - lang: curl
        label: Self-Hosted
        source: "curl -X GET \"SELF_HOSTED_CONTROL_PLANE_URL/admin/users/invites?email=user@example.com\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\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# List user invites\nuser_invites = portkey.admin.users.invites.list(\n    email=\"user@example.com\"\n)\n\nprint(user_invites)\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 user=await portkey.admin.users.invites.list({\n    email:\"user@example.com\"\n});\nconsole.log(user);\n"
  /admin/users/invites/{inviteId}:
    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:
      tags:
      - User-invites
      summary: Get Invite
      parameters:
      - name: inviteId
        in: path
        schema:
          type: string
        required: true
        description: string
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invite'
              example:
                object: invite
                id: 419641fb-1458-47d6-94d0-e308159b3ec2
                email: horace.slughorn@example.com
                role: member
                created_at: '2023-12-12 13:56:32'
                expires_at: '2023-12-12 13:56:32'
                accepted_at: '2023-12-12 13:56:32'
                status: pending
                invited_by: 8dcfa174-c5ed-42c7-8a63-be755cc6e3123
                workspaces:
                - workspace_id: ''
                  role: ''
      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# Get a user invite\nuser = portkey.admin.users.invites.retrieve(\n    invite_id='INVITE_ID'\n)\n\nprint(user)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst user=await portkey.admin.users.invites.retrieve({\n    inviteId: 'INVITE_ID',\n});\nconsole.log(user);\n"
      - lang: curl
        label: Default
        source: "curl -X GET \"https://api.portkey.ai/v1/admin/users/invites/INVITE_ID\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"
      - lang: curl
        label: Self-Hosted
        source: "curl -X GET \"SELF_HOSTED_CONTROL_PLANE_URL/admin/users/invites/INVITE_ID\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\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# Get a user invite\nuser = portkey.admin.users.invites.retrieve(\n    invite_id='INVITE_ID'\n)\n\nprint(user)\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 user=await portkey.admin.users.invites.retrieve({\n    inviteId: 'INVITE_ID',\n});\nconsole.log(user);\n"
    delete:
      tags:
      - User-invites
      summary: Delete Invite By ID
      parameters:
      - name: inviteId
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example: {}
      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\n\n# Delete a user invite\nuser = portkey.admin.users.invites.delete(\n    invite_id=\"INVITE_ID\"\n)\n\nprint(user)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst user=await portkey.admin.users.invites.delete({\n    inviteId:\"INVITE_ID\"\n})\n\nconsole.log(user);\n"
      - lang: curl
        label: Default
        source: "curl -X DELETE \"https://api.portkey.ai/v1/admin/users/invites/INVITE_ID\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"
      - lang: curl
        label: Self-Hosted
        source: "curl -X DELETE \"SELF_HOSTED_CONTROL_PLANE_URL/admin/users/invites/INVITE_ID\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\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# Delete a user invite\nuser = portkey.admin.users.invites.delete(\n    invite_id=\"INVITE_ID\"\n)\n\nprint(user)\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 user=await portkey.admin.users.invites.delete({\n    inviteId:\"INVITE_ID\"\n})\n\nconsole.log(user);\n"
  /admin/users/invites/{inviteId}/resend:
    servers:
    - url: https://api.portkey.ai/v1
      description: Portkey API Public Endpoint
    - url: SELF_HOSTED_CONTROL_PLANE_URL
      description: Self-Hosted Control Plane URL
    post:
      tags:
      - User-invites
      summary: Resend Invite
      description: Resend an invite to user for your organization
      parameters:
      - name: inviteId
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
                properties:
                  inviteLink:
                    type: string
                    format: uri
              example:
                inviteLink: https://app.portkey.ai/invite/some-invite-link
      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\n\n# Delete a user invite\nuser = portkey.admin.users.invites.resend(\n    invite_id=\"INVITE_ID\"\n)\n\nprint(user)\n"
      - lang: javascript
        label: Default
        source: "import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n    apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst user=await portkey.admin.users.invites.resend({\n    inviteId:\"INVITE_ID\"\n});\n\nconsole.log(user);\n"
      - lang: curl
        label: Default
        source: "curl -X POST \"https://api.portkey.ai/v1/admin/users/invites/INVITE_ID/resend\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"
      - lang: curl
        label: Self-Hosted
        source: "curl -X POST \"SELF_HOSTED_CONTROL_PLANE_URL/admin/users/invites/INVITE_ID/resend\"\n  -H \"x-portkey-api-key: PORTKEY_API_KEY\"\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# Delete a user invite\nuser = portkey.admin.users.invites.resend(\n    invite_id=\"INVITE_ID\"\n)\n\nprint(user)\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 user=await portkey.admin.users.invites.resend({\n    inviteId:\"INVITE_ID\"\n});\n\nconsole.log(user);\n"
components:
  schemas:
    SuccessInvite:
      type: object
      required:
      - id
      - invite_link
      properties:
        id:
          type: string
        invite_link:
          type: string
      example:
        id: a286286b-633d-4c4f-bddb-86b84a50a25c
        invite_link: https://app.portkey.ai/invite_id
    InviteRole:
      type: string
      enum:
      - admin
      - member
    CreateInvite:
      type: object
      required:
      - email
      - workspaces
      - role
      properties:
        email:
          type: string
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceInvite'
        role:
          $ref: '#/components/schemas/InviteRole'
        workspace_api_key_details:
          type: object
          properties:
            scopes:
              type: array
              items:
                type: string
          required:
          - scopes
      example:
        email: test@john.doe
        role: admin
        workspaces:
        - id: ws-slug
          role: member
    Invite:
      type: object
      properties:
        object:
          type: string
          example: invite
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        role:
          type: string
          enum:
          - admin
          - member
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        accepted_at:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - pending
          - cancelled
          - accepted
          - expired
        invited_by:
          type: string
          format: uuid
    WorkspaceInviteRole:
      type: string
      enum:
      - admin
      - member
      - manager
    WorkspaceInvite:
      type: object
      required:
      - id
      - role
      properties:
        id:
          type: string
          description: Workspace Slug
        role:
          $ref: '#/components/schemas/WorkspaceInviteRole'
    InviteList:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/Invite'
  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: getRunStep
      path: getRunStep
    - type: object
      key: RunStepObject
      path: step-object
  - id: vector-stores
    title: Vector Stores
    beta: true
    description: 'Vector stores are used to store files for use by the `file_search` tool.


      Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createVectorStore
      path: create
    - type: endpoint
      key: listVectorStores
      path: list
    - type: endpoint
      key: getVectorStore
      path: retrieve
    - type: endpoint
      key: modifyVectorStore
      path: modify
    - type: endpoint
      key: deleteVectorStore
      path: delete
    - type: object
      key: VectorStoreObject
      path: object
  - id: vector-stores-files
    title: Vector Store Files
    beta: true
    description: 'Vector store files represent files inside a vector store.


      Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createVectorStoreFile
      path: createFile
    - type: endpoint
      key: listVectorStoreFiles
      path: listFiles
    - type: endpoint
      key: getVectorStoreFile
      path: getFile
    - type: endpoint
      key: deleteVectorStoreFile
      path: deleteFile
    - type: object
      key: VectorStoreFileObject
      path: file-object
  - id: vector-stores-file-batches
    title: Vector Store File Batches
    beta: true
    description: 'Vector store file batches represent operations to add multiple files to a vector store.


      Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)

      '
    navigationGroup: assistants
    sections:
    - type: endpoint
      key: createVectorStoreFileBatch
      path: createBatch
    - type: endpoint
      key: getVectorStoreFileBatch
      path: getBatch
    - type: endpoint
      key: cancelVectorStoreFileBatch
      path: cancelBatch
    - type: endpoint
      key: listFilesInVectorStoreBatch
      path: listBatchFiles
    - type: object
      key: VectorStoreFileBatchObject
      path: batch-object
  - id: assistants-streaming
    title: Streaming
    beta: true
    description: 'Stream the result of executing a Run or resuming a Run after submitting tool outputs.


      You can stream events from the [Create Thread and Run](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun),

      [Create Run](https://platf

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