Scale AI Credentials API

openapi: 3.2.0
info:
  title: EGP API V5 Credentials 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: Credentials
paths:
  /v5/credentials:
    post:
      tags:
      - Credentials
      summary: Create Credential
      description: Create a new credential for storing sensitive data like API keys, tokens, or other secrets.
      operationId: POST-V5-/v5/credentials
      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/CreateCredentialRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/create-credential
    get:
      tags:
      - Credentials
      summary: List Credentials
      description: Retrieve a paginated list of all credentials for the current account with optional name filtering.
      operationId: GET-V5-/v5/credentials
      parameters:
      - name: name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter credentials by name
          title: Name
        description: Filter credentials by name
      - 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_Credential_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/list-credentials
  /v5/credentials/{credential_id}:
    delete:
      tags:
      - Credentials
      summary: Delete Credential
      description: Permanently delete a credential and all its associated data.
      operationId: DELETE-V5-/v5/credentials/credential_id
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          title: Credential 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/DeleteResponse_Credential_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/delete-credential
    get:
      tags:
      - Credentials
      summary: Get Credential by ID
      description: Retrieve a specific credential by its unique identifier.
      operationId: GET-V5-/v5/credentials/credential_id
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          title: Credential 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/Credential'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/get-credential-by-id
    patch:
      tags:
      - Credentials
      summary: Update Credential
      description: Update an existing credential's properties including name, description, type, payload, and metadata.
      operationId: PATCH-V5-/v5/credentials/credential_id
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          title: Credential 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/UpdateCredentialRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/update-credential
  /v5/credentials/name/{credential_name}:
    get:
      tags:
      - Credentials
      summary: Get Credential by Name
      description: Retrieve a specific credential by its name.
      operationId: GET-V5-/v5/credentials/name/credential_name
      parameters:
      - name: credential_name
        in: path
        required: true
        schema:
          type: string
          title: Credential Name
      - 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/Credential'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/get-credential-by-name
  /v5/credentials/{credential_id}/secret:
    post:
      tags:
      - Credentials
      summary: Get Credential Secret by ID
      description: Retrieve the plaintext payload of a credential by its ID.
      operationId: POST-V5-/v5/credentials/credential_id/secret
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          title: Credential 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/DecryptCredentialResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/get-credential-secret-by-id
  /v5/credentials/name/{credential_name}/secret:
    post:
      tags:
      - Credentials
      summary: Get Credential Secret by Name
      description: Retrieve the plaintext payload of a credential by its name.
      operationId: POST-V5-/v5/credentials/name/credential_name/secret
      parameters:
      - name: credential_name
        in: path
        required: true
        schema:
          type: string
          title: Credential Name
      - 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/DecryptCredentialResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/credentials/get-credential-secret-by-name
components:
  schemas:
    Credential:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          title: Object
          default: credential
        created_by_user_id:
          title: Created By User Id
          type: string
        created_by_identity_type:
          title: Created By Identity Type
          type: string
        type:
          type: string
          title: Type
        name:
          type: string
          title: Name
        description:
          title: Description
          type: string
        credential_metadata:
          title: Credential Metadata
          additionalProperties: true
          type: object
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - created_by_user_id
      - created_by_identity_type
      - type
      - name
      - description
      - credential_metadata
      - created_at
      - updated_at
    PaginatedList_Credential_:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        items:
          items:
            $ref: '#/components/schemas/Credential'
          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
    CreateCredentialRequest:
      properties:
        type:
          type: string
          minLength: 1
          title: Type
          description: 'Type of credential: key or json'
        name:
          type: string
          minLength: 1
          title: Name
          description: User-friendly name for the credential
        description:
          title: Description
          description: Optional description
          type: string
        payload:
          type: string
          minLength: 1
          format: password
          title: Payload
          description: The credential payload to be encrypted
          writeOnly: true
        credential_metadata:
          title: Credential Metadata
          description: Optional unencrypted credential_metadata
          additionalProperties: true
          type: object
      type: object
      required:
      - type
      - name
      - payload
      title: CreateCredentialRequest
    DeleteResponse_Credential_:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          title: Object
          default: credential
        deleted:
          type: boolean
          title: Deleted
      type: object
      required:
      - id
      - deleted
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UpdateCredentialRequest:
      properties:
        name:
          title: Name
          description: User-friendly name for the credential
          type: string
        description:
          title: Description
          description: Optional description
          type: string
        type:
          title: Type
          description: 'Type of credential: key or json'
          type: string
        payload:
          title: Payload
          description: The credential payload to be encrypted
          type: string
          format: password
          writeOnly: true
        credential_metadata:
          title: Credential Metadata
          description: Optional unencrypted credential_metadata
          additionalProperties: true
          type: object
      type: object
      title: UpdateCredentialRequest
    SortOrder:
      type: string
      enum:
      - asc
      - desc
      title: SortOrder
    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
    DecryptCredentialResponse:
      properties:
        object:
          type: string
          title: Object
          default: credential_decrypt
        result:
          type: string
          title: Result
      type: object
      required:
      - result
  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)