EvalGate agent onboarding API

The agent onboarding API from EvalGate — 3 operation(s) for agent onboarding.

GitHub OpenAPI

Operations 4

GET /api/agent-setup/authorize Review an agent credential handoff #
POST /api/agent-setup/authorize Approve or deny an agent credential handoff #
POST /api/agent-setup/poll Poll a human-approved agent credential handoff #
POST /api/agent-setup/start Start a human-approved agent credential handoff #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/evalgate-com:evalgate-com-agent-onboarding-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

evalgate-com-agent-onboarding-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: EvalGate agent onboarding API
  version: 18.13.0
  description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
- url: https://evalgate.com
  description: Production
- url: http://localhost:3000
  description: Local
tags:
- name: agent onboarding
paths:
  /api/agent-setup/authorize:
    get:
      x-evalgate-source-hash: sha256:79616e16673c0a140234d61cbafc62ef5ba862c45bc1ac723ea387e529abca99
      summary: Review an agent credential handoff
      operationId: reviewAgentCredentialHandoff
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAgentSetupAuthorizeResponse200ApplicationJson'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - browserSession: []
      tags:
      - agent onboarding
      x-evalgate-required-scopes:
      - admin:keys
      parameters:
      - name: user_code
        in: query
        required: true
        schema:
          type: string
      - in: query
        name: claim_attempt_token
        required: false
        description: Required for service-auth claims, bound to this exact claim attempt. Treat as a secret.
        schema:
          type: string
      description: Returns the requesting client, exact scopes, expiry, state and active organization to a signed-in organization admin. API-key authentication is rejected because a person must review this request. Service-auth claims require the attempt token from the exact claim link; never log or persist this token.
      x-evalgate-contract-hash: sha256:85cb962d003896d1527826f2980ce959d91809cb8ca05dac3a2ffaffb4d4e112
      x-evalgate-human-approval-required: true
      x-evalgate-browser-session-required: true
    post:
      x-evalgate-source-hash: sha256:f35ee6bc25f9017e32ca6a3542d912abf73cf870cf12c267317ddc164f729226
      summary: Approve or deny an agent credential handoff
      operationId: decideAgentCredentialHandoff
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentSetupAuthorizeResponse200ApplicationJson'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - browserSession: []
      tags:
      - agent onboarding
      x-evalgate-request-validators:
      - decideAgentCredentialHandoffSchema
      x-evalgate-required-scopes:
      - admin:keys
      description: A signed-in organization admin approves or denies the exact reviewed request and scopes. Send organization_id from the reviewed preview; a changed active workspace is rejected. Service-auth claims additionally require claim_attempt_token from the exact claim link. Approval cannot grant administrative scopes or exceed the admin's role.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentSetupAuthorizeRequest'
      x-evalgate-contract-hash: sha256:7f00fa91632146a7b70c639ead1bdfccefe7014a731b865ec0fc17dab607c080
      x-evalgate-human-approval-required: true
      x-evalgate-browser-session-required: true
  /api/agent-setup/poll:
    post:
      x-evalgate-source-hash: sha256:ec9fd27ae3249fcbcfbfc3869e8c71d08afc441891a277999293c5ea10c05a29
      summary: Poll a human-approved agent credential handoff
      operationId: pollAgentCredentialHandoff
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentSetupPollResponse200ApplicationJson'
        '202':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentSetupPollResponse202ApplicationJson'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          description: Handoff expired or credential already delivered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security: []
      tags:
      - agent onboarding
      x-evalgate-request-validators:
      - pollAgentCredentialHandoffSchema
      description: Poll no faster than the interval returned by the start operation. Pending requests return 202; fast polling returns 429 with Retry-After; approval returns one organization-scoped, expiring API key exactly once. Denied, expired, or consumed handoffs never return a credential.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentSetupPollRequest'
      x-evalgate-contract-hash: sha256:210e9a7abe9084c086b9cffbf244fe02557cf7d2f40d28eeb88acc21c698fd5c
      x-evalgate-one-time-secret: true
  /api/agent-setup/start:
    post:
      x-evalgate-source-hash: sha256:5fdf5ac21176e68f416b7a80cecd638850e8096020fdd4985866d8bea0cf04e9
      summary: Start a human-approved agent credential handoff
      operationId: startAgentCredentialHandoff
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentSetupStartResponse201ApplicationJson'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security: []
      tags:
      - agent onboarding
      x-evalgate-request-validators:
      - startAgentCredentialHandoffSchema
      description: Creates only a short-lived setup request. It does not create an identity, API key, hosted evaluation, or billable action. A signed-in organization admin must separately approve the exact workspace and scopes through GitHub or Google sign-in. This is an EvalGate API-key handoff, not an OAuth token endpoint.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentSetupStartRequest'
      x-evalgate-contract-hash: sha256:040d243ca868531e060e87ff70f1a813b6eb03af79fe3bf06b76dd8c1b4d458f
      x-evalgate-human-approval-required: true
components:
  schemas:
    PostApiAgentSetupPollResponse202ApplicationJson:
      type: object
      properties:
        status:
          type: string
        interval:
          type: number
      additionalProperties: false
      required:
      - status
      - interval
    GetApiAgentSetupAuthorizeResponse200ApplicationJson:
      type: object
      properties:
        client_name:
          type: string
        requested_scopes:
          type: array
          items:
            type: string
        status:
          oneOf:
          - type: string
            enum:
            - pending
          - type: string
            enum:
            - approved
          - type: string
            enum:
            - expired
          - type: string
            enum:
            - denied
          - type: string
            enum:
            - consumed
        expires_at:
          type: string
        organization_id:
          type: string
      additionalProperties: false
      required:
      - client_name
      - requested_scopes
      - status
      - expires_at
      - organization_id
    PostApiAgentSetupStartResponse201ApplicationJson:
      type: object
      properties:
        device_code:
          type: string
        user_code:
          type: string
        verification_uri:
          type: string
        verification_uri_complete:
          type: string
        expires_in:
          type: number
        interval:
          type: number
      additionalProperties: false
      required:
      - device_code
      - user_code
      - verification_uri
      - verification_uri_complete
      - expires_in
      - interval
    PostApiAgentSetupPollRequest:
      type: object
      properties:
        device_code:
          type: string
      additionalProperties: false
      required:
      - device_code
    PostApiAgentSetupStartRequest:
      type: object
      properties:
        client_name:
          type: string
        requested_scopes:
          type: array
          items:
            type: string
      additionalProperties: false
    PostApiAgentSetupAuthorizeRequest:
      type: object
      properties:
        user_code:
          type: string
        decision:
          oneOf:
          - type: string
            enum:
            - approve
          - type: string
            enum:
            - deny
        organization_id:
          type: string
        claim_attempt_token:
          type: string
      additionalProperties: false
      required:
      - user_code
      - decision
      - organization_id
    PostApiAgentSetupPollResponse200ApplicationJson:
      type: object
      properties:
        status:
          type: string
        api_key:
          type: string
        token_type:
          type: string
        scopes:
          type: array
          items:
            type: string
        expires_at:
          type: string
      additionalProperties: false
      required:
      - status
      - api_key
      - token_type
      - scopes
      - expires_at
    PostApiAgentSetupAuthorizeResponse200ApplicationJson:
      type: object
      properties:
        status:
          oneOf:
          - type: string
            enum:
            - approved
          - type: string
            enum:
            - denied
      additionalProperties: false
      required:
      - status
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - UNAUTHORIZED
              - FORBIDDEN
              - NOT_FOUND
              - INVALID_REFERENCE
              - VALIDATION_ERROR
              - RATE_LIMITED
              - CONFLICT
              - INTERNAL_ERROR
              - SERVICE_UNAVAILABLE
              - QUOTA_EXCEEDED
              - FEATURE_LIMIT_REACHED
              - NO_ORG_MEMBERSHIP
              - SHARE_REVOKED
              - SHARE_EXPIRED
              - SHARE_UNAVAILABLE
              - PROVIDER_KEY_MISSING
              - PROVIDER_KEY_EXPIRED
              - PROVIDER_RATE_LIMITED
              - PROVIDER_UNAUTHORIZED
              - PROVIDER_UNAVAILABLE
              - AGENT_HANDOFF_INVALID
              - AGENT_HANDOFF_EXPIRED
              - AGENT_HANDOFF_DENIED
              - AGENT_HANDOFF_CONSUMED
              - PAYLOAD_TOO_LARGE
              - METHOD_NOT_ALLOWED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
            redaction:
              type: object
              properties:
                applied:
                  type: boolean
                  enum:
                  - true
                fieldCount:
                  type: integer
                  minimum: 0
                secretCount:
                  type: integer
                  minimum: 0
              required:
              - applied
              - fieldCount
              - secretCount
          required:
          - code
          - message
      required:
      - error
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
        WWW-Authenticate:
          description: Bearer challenge. Agent-facing routes include the RFC 9728 resource_metadata URL.
          schema:
            type: string
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
        Retry-After:
          description: Delay in seconds before retrying when present.
          schema:
            type: integer
            minimum: 1
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: IETF HTTPAPI structured remaining quota and reset delay (work in progress).
          schema:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: EvalGate API key
      description: Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
      x-evalgate-scopes-supported:
      - eval:read
      - eval:write
      - objectives:read
      - objectives:write
      - runs:read
      - runs:write
      - traces:read
      - traces:write
      - exports:download
      - reports:write
      - prompt:publish
      - scorer:publish
      - red_team:read
      - red_team:run
      - red_team:approve
      - docs:read
      - agent:read
      - agent:execute
      - resources:read
      - resources:write
      - contexts:read
      - contexts:write
      - observations:write
      - checks:read
      - checks:run
      - standards:read
      - standards:write
      - standards:approve
      - grants:read
      - grants:write
      - admin:keys
      - admin:workspace
      - admin:org
      x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource
    ProviderHealthSignature:
      type: apiKey
      in: header
      name: x-evalgate-provider-health-signature
      description: HMAC SHA-256 signature over the exact provider request bytes. Provider requests also require the timestamp and key-id headers.
    browserSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Interactive EvalGate browser session established through GitHub or Google sign-in. This scheme represents the human approval step and is not an agent API key or an EvalGate OAuth authorization-server token.
x-service-info:
  categories:
  - ai
  - developer-tools
  docs:
    homepage: https://evalgate.com
    apiReference: https://docs.evalgate.com/api-reference
    llms: https://evalgate.com/llms.txt