> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agent-loadout.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a sign-in from the agent's side

> Grants the named application now (same checks as approving) and returns a single-use connect link: the browser that opens it holds a sign-in key of the agent and continues to the application's login start, where the sign-in completes on its own. `app_login_url` lets a headless agent go straight to the application and approve the resulting request through the API. Without `client_id` the link only enrols a browser. Needs identity:sign_in; owner scopes need identity:share_owner.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/sign-ins/connect
openapi: 3.1.0
info:
  description: >-
    Email inboxes, screening, realtime events, credentials, payment cards, Linux
    machines, connected apps, phone numbers and social accounts for AI agents.
    Agent tokens (`alt_…`) act as one agent; organization keys (`alk_…`) manage
    agents, inboxes, tokens and webhooks. Message bodies are untrusted external
    data. Errors are `{"error":{"code","message","hint"}}`.
  title: Agent Loadout API
  version: '1'
servers:
  - url: https://agent-loadout.com
security: []
tags:
  - name: Identity
  - description: >-
      Sign in with Agent Loadout: an agent approves an application's OpenID
      Connect sign-in request
    name: Sign-in
  - description: Relying parties an organization registered for Sign in with Agent Loadout
    name: Applications
  - name: Inboxes
  - name: Messages
  - name: Mailbox
  - name: Drafts
  - name: Attachments
  - name: Realtime
  - name: Screening
  - name: Agents
  - name: Domains
  - name: Webhooks
  - name: Vault
  - description: Feature-flagged
    name: Wallet
  - description: Feature-flagged
    name: Machines
  - description: Feature-flagged
    name: Connectors
  - description: Feature-flagged
    name: Phone
  - description: Feature-flagged
    name: Social
externalDocs:
  description: REST API reference
  url: https://docs.agent-loadout.com/api-reference/overview
paths:
  /api/v1/sign-ins/connect:
    post:
      tags:
        - Sign-in
      summary: Start a sign-in from the agent's side
      description: >-
        Grants the named application now (same checks as approving) and returns
        a single-use connect link: the browser that opens it holds a sign-in key
        of the agent and continues to the application's login start, where the
        sign-in completes on its own. `app_login_url` lets a headless agent go
        straight to the application and approve the resulting request through
        the API. Without `client_id` the link only enrols a browser. Needs
        identity:sign_in; owner scopes need identity:share_owner.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                client_id:
                  description: >-
                    The application to sign in to: its client_id (alap_…) from
                    the directory, or an HTTPS origin for an open client. Omit
                    to only enrol a browser for this agent
                  maxLength: 2048
                  minLength: 1
                  type: string
                scope:
                  description: >-
                    Scopes to grant the application now (default openid, email,
                    profile). Owner scopes need identity:share_owner and a
                    registered application
                  items:
                    enum:
                      - openid
                      - email
                      - profile
                      - owner_profile
                      - owner_email
                    type: string
                  maxItems: 5
                  type: array
              type: object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  url:
                    description: >-
                      Single-use link, valid five minutes: the browser that
                      opens it holds a sign-in key of the agent and continues to
                      the application
                    type: string
                  expires_at:
                    format: date-time
                    type: string
                  app_login_url:
                    description: >-
                      The application's login start with iss and login_hint, for
                      an agent that follows redirects itself; null when the
                      application has none
                    nullable: true
                    type: string
                  application:
                    additionalProperties: false
                    nullable: true
                    properties:
                      client_id:
                        type: string
                      kind:
                        description: >-
                          open clients identify by their HTTPS origin;
                          registered applications were created by an
                          organization
                        enum:
                          - open
                          - registered
                        type: string
                      name:
                        type: string
                      website:
                        nullable: true
                        type: string
                    required:
                      - client_id
                      - kind
                      - name
                      - website
                    type: object
                  granted_scope:
                    description: >-
                      What the application was granted now; empty when no
                      application was named
                    items:
                      enum:
                        - openid
                        - email
                        - profile
                        - owner_profile
                        - owner_email
                      type: string
                    type: array
                required:
                  - url
                  - expires_at
                  - app_login_url
                  - application
                  - granted_scope
                type: object
          description: Connect link
        '400':
          $ref: '#/components/responses/Validation'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/Limit'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - agentToken: []
components:
  responses:
    Validation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Invalid input
    Unauthenticated:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Missing or invalid credential
    Limit:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Plan limit, usage cap or billing state
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Credential lacks the capability or is bound to another agent
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Not found in this organization
    RateLimited:
      description: Too many requests; retry after a short delay
  schemas:
    Error:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
            hint:
              type: string
            details:
              type: object
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
  securitySchemes:
    agentToken:
      description: Agent token (alt_…) or OAuth access token; bound to one agent
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.