> ## Documentation Index
> Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-docs-ia-v2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a credential

> Create a new credential for storing login information.



## OpenAPI

````yaml https://api.onkernel.com/spec.json post /credentials
openapi: 3.1.0
info:
  description: Developer tools and cloud infrastructure for AI agents to use web browsers
  title: Kernel API
  version: 0.1.0
servers:
  - description: API Server
    url: https://api.onkernel.com
security:
  - bearerAuth: []
tags:
  - description: Search the web and retrieve content for selected results.
    name: Search
  - description: Create and manage browser sessions.
    name: Browsers
  - description: Control mouse, keyboard, and screen on the browser instance.
    name: Browser Computer Controls
  - description: Execute Playwright code against the browser instance.
    name: Browser Playwright
  - description: Execute JavaScript in the browser instance's persistent Browser REPL.
    name: Browser REPL
  - description: Discover and invoke native page tools across the browser instance.
    name: Browser WebMCP
  - description: Read, write, and manage files on the browser instance.
    name: Browser Filesystem
  - description: Execute and manage processes on the browser instance.
    name: Browser Processes
  - description: Record and manage browser session video replays.
    name: Browser Replays
  - description: Stream logs from the browser instance.
    name: Browser Logs
  - description: >-
      Stream live telemetry events from a browser session, and manage the
      destinations sessions export them to.
    name: Browser Telemetry
  - description: Create, list, retrieve, and delete browser profiles.
    name: Profiles
  - description: Create and manage proxy configurations for routing browser traffic.
    name: Proxies
  - description: Create, list, retrieve, and delete browser extensions.
    name: Extensions
  - description: Create and manage browser pools for acquiring and releasing browsers.
    name: Browser Pools
  - description: Inspect the identity and authorization context for the current request.
    name: Authentication
  - description: >-
      Create and manage auth connections for automated credential capture and
      login.
    name: Managed Auth
  - description: Create and manage credentials for authentication.
    name: Credentials
  - description: Configure external credential providers like 1Password.
    name: Credential Providers
  - description: List applications and versions.
    name: Apps
  - description: Create and manage app deployments and stream deployment events.
    name: Deployments
  - description: Invoke actions and stream or query invocation status and events.
    name: Invocations
  - description: Read and manage organization-level limits.
    name: Organization
  - description: |
      Create and manage projects for resource isolation within an organization.
      When projects are disabled for the organization, project operations return
      `404` with code `projects_disabled`.
    name: Projects
  - description: Create and manage API keys for organization and project-scoped access.
    name: API Keys
  - description: Read audit log records for the authenticated organization.
    name: Audit Logs
  - description: Resolve browser and proxy recommendations for bot-protected sites.
    name: Config Registry
paths:
  /credentials:
    post:
      tags:
        - Credentials
      summary: Create a credential
      description: Create a new credential for storing login information.
      operationId: postCredentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
          description: Credential created successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    CreateCredentialRequest:
      additionalProperties: false
      description: Request to create a new credential
      properties:
        domain:
          description: Target domain this credential is for
          example: netflix.com
          type: string
        name:
          description: Unique name for the credential within the project
          example: my-netflix-login
          type: string
        sso_provider:
          description: >-
            If set, indicates this credential should be used with the specified
            SSO provider (e.g., google, github, microsoft). When the target site
            has a matching SSO button, it will be clicked first before filling
            credential values on the identity provider's login page.
          example: google
          type: string
        totp_secret:
          description: >-
            Base32-encoded TOTP secret for generating one-time passwords. Used
            for automatic 2FA during login.
          example: JBSWY3DPEHPK3PXP
          type: string
        values:
          additionalProperties:
            type: string
          description: Field name to value mapping (e.g., username, password)
          example:
            password: mysecretpassword
            username: user@example.com
          type: object
      required:
        - name
        - domain
        - values
      type: object
    Credential:
      additionalProperties: false
      description: A stored credential for automatic re-authentication
      properties:
        created_at:
          description: When the credential was created
          example: '2025-01-15T10:30:00Z'
          format: date-time
          type: string
        domain:
          description: Target domain this credential is for
          example: netflix.com
          type: string
        has_totp_secret:
          description: >-
            Whether this credential has a TOTP secret configured for automatic
            2FA
          example: false
          type: boolean
        has_values:
          description: Whether this credential has stored values (email, password, etc.)
          example: true
          type: boolean
        id:
          description: Unique identifier for the credential
          example: cred_abc123xyz
          type: string
        name:
          description: Unique name for the credential within the project
          example: my-netflix-login
          type: string
        sso_provider:
          description: >-
            If set, indicates this credential should be used with the specified
            SSO provider (e.g., google, github, microsoft). When the target site
            has a matching SSO button, it will be clicked first before filling
            credential values on the identity provider's login page.
          example: google
          nullable: true
          type: string
        totp_code:
          description: >-
            Current 6-digit TOTP code. Only included in create/update responses
            when totp_secret was just set.
          example: '847291'
          type: string
        totp_code_expires_at:
          description: When the totp_code expires. Only included when totp_code is present.
          example: '2025-01-15T10:30:30Z'
          format: date-time
          type: string
        updated_at:
          description: When the credential was last updated
          example: '2025-01-15T10:30:00Z'
          format: date-time
          type: string
        value_keys:
          description: >-
            The field names stored in this credential's values (e.g., username,
            password). Values themselves are never returned. Included on
            single-credential responses (create, get by id or name, update);
            omitted from list responses.
          example:
            - username
            - password
          items:
            type: string
          type: array
      required:
        - id
        - name
        - domain
        - created_at
        - updated_at
      type: object
    Error:
      properties:
        code:
          description: Application-specific error code (machine-readable)
          example: bad_request
          type: string
        details:
          description: Additional error details (for multiple errors)
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        inner_error:
          $ref: '#/components/schemas/ErrorDetail'
        message:
          description: Human-readable error description for debugging
          example: 'Missing required field: app_name'
          type: string
      required:
        - code
        - message
      type: object
    ErrorDetail:
      properties:
        code:
          description: Lower-level error code providing more specific detail
          example: invalid_input
          type: string
        message:
          description: Further detail about the error
          example: Provided version string is not semver compliant
          type: string
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Bad Request – invalid input
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized – missing or invalid authorization token
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Forbidden – insufficient permissions or plan
    Conflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Conflict – resource already exists
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal Server Error
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````