Scale AI SGP Cloud Secrets API

openapi: 3.2.0
info:
  title: EGP API V5 SGP Cloud Secrets API
  description: This is the parent API for all EGP APIs. If you are looking for the EGP API, please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
- url: https://api.egp.scale.com
security: []
tags:
- name: SGP Cloud Secrets
paths:
  /v5/sgp/secrets:
    post:
      tags:
      - SGP Cloud Secrets
      summary: Create Secret
      description: 'Create an account-level secret.


        The secret value is stored in the cloud provider''s secret store.

        SGP only stores metadata (key name, description, audit info).

        The value is never returned by any API.

        Returns 409 if a secret with the same key already exists.'
      operationId: POST-V5-/sgp/secrets
      parameters:
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SgpCloudSecretCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SgpCloudSecret'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/create-secret
    get:
      tags:
      - SGP Cloud Secrets
      summary: List Secrets
      description: List secret metadata for the account. Values are never returned.
      operationId: GET-V5-/sgp/secrets
      parameters:
      - name: starting_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Starting After
      - name: ending_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Ending Before
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          default: 100
          title: Limit
      - name: sort_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sort By
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/SortOrder'
          - type: 'null'
          default: asc
          title: Sort Order
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList_SgpCloudSecret_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/list-secrets
  /v5/sgp/secrets/{secret_id}:
    delete:
      tags:
      - SGP Cloud Secrets
      summary: Delete Secret
      description: Delete a secret from both the cloud provider and SGP metadata.
      operationId: DELETE-V5-/sgp/secrets/secret_id
      parameters:
      - name: secret_id
        in: path
        required: true
        schema:
          type: string
          title: Secret Id
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/delete-secret
    get:
      tags:
      - SGP Cloud Secrets
      summary: Get Secret
      description: Get a single secret's metadata by ID. The value is never returned.
      operationId: GET-V5-/sgp/secrets/secret_id
      parameters:
      - name: secret_id
        in: path
        required: true
        schema:
          type: string
          title: Secret Id
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SgpCloudSecret'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/get-secret
    patch:
      tags:
      - SGP Cloud Secrets
      summary: Update Secret
      description: 'Update an existing secret''s description and/or value.


        If value is provided, the cloud provider secret is updated.

        The secret value is never returned by any API.'
      operationId: PATCH-V5-/sgp/secrets/secret_id
      parameters:
      - name: secret_id
        in: path
        required: true
        schema:
          type: string
          title: Secret Id
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SgpCloudSecretUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SgpCloudSecret'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/update-secret
components:
  schemas:
    SgpCloudSecretCreateRequest:
      properties:
        key:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
          title: Key
          description: Secret name (e.g. openai-api-key). Must be lowercase alphanumeric with hyphens (no dots or underscores), so it maps 1:1 to a valid secret name on every cloud backend (AWS / Azure Key Vault / GCP Secret Manager).
        value:
          type: string
          minLength: 1
          title: Value
          description: The secret value to store
        description:
          title: Description
          description: Optional human-readable description
          type: string
      type: object
      required:
      - key
      - value
      title: SgpCloudSecretCreateRequest
      description: Request body for creating a secret.
    IdentityType:
      type: string
      enum:
      - user
      - service_account
      title: IdentityType
    SortOrder:
      type: string
      enum:
      - asc
      - desc
      title: SortOrder
    SgpCloudSecretUpdateRequest:
      properties:
        description:
          title: Description
          description: Updated human-readable description
          type: string
        value:
          title: Value
          description: Updated secret value to store in cloud provider
          type: string
          minLength: 1
      type: object
      title: SgpCloudSecretUpdateRequest
      description: Request body for updating an existing secret's description and/or value.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SgpCloudSecret:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the entity.
        object:
          type: string
          const: sgp_cloud_secret
          title: Object
          default: sgp_cloud_secret
        key:
          type: string
          title: Key
          description: Secret name, e.g. OPENAI_API_KEY.
        description:
          title: Description
          description: Optional human-readable description of the secret.
          type: string
        cloud_secret_path:
          type: string
          title: Cloud Secret Path
          description: Full path in the cloud secret store.
        updated_by:
          title: Updated By
          description: User who last updated the secret.
          type: string
        updated_at:
          title: Updated At
          description: Timestamp of last update.
          type: string
          format: date-time
        account_id:
          type: string
          title: Account Id
          description: The ID of the account that owns the given entity.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date and time when the entity was created in ISO format.
        created_by:
          $ref: '#/components/schemas/Identity'
          description: The identity that created the entity.
      type: object
      required:
      - key
      - cloud_secret_path
      - id
      - account_id
      - created_at
      - created_by
      description: API response model for a secret. Never includes the secret value.
    PaginatedList_SgpCloudSecret_:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        items:
          items:
            $ref: '#/components/schemas/SgpCloudSecret'
          type: array
          title: Items
        limit:
          type: integer
          title: Limit
          description: The maximum number of items to return.
          default: 100
        total:
          type: integer
          title: Total
          description: The total of items that match the query. This is greater than or equal to the number of items returned.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more items left to be fetched.
      type: object
      required:
      - items
      - total
      - has_more
    Identity:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          const: identity
          title: Object
          default: identity
        type:
          $ref: '#/components/schemas/IdentityType'
      type: object
      required:
      - id
      - type
      title: Identity
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
x-assembled-from: Per-operation OpenAPI fragments embedded verbatim in docs.gp.scale.com reference pages; source spec https://api.sgp.scale.com/openapi-versions/v5/openapi.json (404 when assembled)