Compeller Auth API

Credential exchange for retrieving a user's API token.

GitHub OpenAPI

Operations 4

POST /api/login Existing login endpoint that returns an access_token accepted by v1 and MCP… #
POST /api/v1/auth/token Login with Compeller credentials and return the user's API token #
POST /api/v1/login Alias for POST /api/v1/auth/token #
POST /api/v1/auth/signup Self-serve agent signup. #

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/compeller-ai:compeller-ai-auth-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. See our Privacy Policy and Terms.

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

OpenAPI Specification

compeller-ai-auth-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compeller Ai Auth API
  version: 1.0.0
  description: 'Operations tagged Auth across 2 of this provider''s published API definitions: compeller-ai-openapi.yaml, compeller-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://compeller.ai
  description: Production
- url: https://dev.compeller.ai
  description: Development
security:
- bearerToken: []
- apiTokenHeader: []
tags:
- name: Auth
  description: Credential exchange for retrieving a user's API token.
paths:
  /api/login:
    post:
      tags:
      - Auth
      operationId: springRestLoginForAccessToken
      summary: Existing login endpoint that returns an access_token accepted by v1 and MCP…
      description: 'Existing Spring Security REST login endpoint. Agents may call this with the user''s

        Compeller username/password to retrieve an `access_token`, then send that value as

        `Authorization: Bearer ` on `/api/v1/*` and `/api/mcp` requests.

        Do not send or depend on a browser/Postman `Cookie` header; JSON credentials are

        sufficient and the cookie is not part of the agent contract.


        The response includes `username` and `access_token`. `roles` is included only

        when the account has elevated roles beyond baseline `ROLE_COMPELLER`.

        `refresh_token` and `expires_in` are included only when the token backend returns them.'
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
            examples:
              login:
                value:
                  username: artist@example.com
                  password: correct-horse-battery-staple
      responses:
        '200':
          description: Spring REST login token response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        '401':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/auth/token:
    post:
      tags:
      - Auth
      operationId: createApiTokenFromCredentials
      summary: Login with Compeller credentials and return the user's API token
      description: 'Agent-friendly credential exchange. Submit the user''s Compeller email and password

        over HTTPS. The response returns the existing opaque API token used by both REST

        (`Authorization: Bearer ` or `X-API-Token`) and MCP (`/api/mcp`).


        This endpoint does not create a browser session or a new JWT. Treat the returned

        token like a password; store it in the caller''s secret store and never paste it

        into public chat/logs.'
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTokenRequest'
            examples:
              login:
                value:
                  email: artist@example.com
                  password: correct-horse-battery-staple
      responses:
        '200':
          description: API token and usage headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthTokenResponse'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/login:
    post:
      tags:
      - Auth
      operationId: loginForApiToken
      summary: Alias for POST /api/v1/auth/token
      description: Compatibility alias for clients that discover a conventional login path.
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTokenRequest'
      responses:
        '200':
          description: API token and usage headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthTokenResponse'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/auth/signup:
    post:
      tags:
      - Auth
      operationId: createAgentSignup
      summary: Self-serve agent signup.
      description: 'Lets a fresh external agent create a Compeller account and receive an

        immediately-usable bearer token without any out-of-band setup. Email

        verification is deferred -- the new account starts with the FREE-plan

        minute allowance and is gated by the existing `Account.isEligibleForApi`

        rules, not by an email-verified flag.


        **Required header:** `User-Agent` (so signups can be attributed to a

        specific agent build).


        **Recommended header:** `X-Agent-Installation-Id` -- a stable opaque

        identifier per installation of your agent (8-128 chars, `[A-Za-z0-9_-]`).

        It is treated as the agent equivalent of a browser fingerprint:

        repeated signups with the same installation id from one IP will be

        throttled with `HTTP 429 application/problem+json`, but already-issued

        tokens are unaffected.


        Sign up **once** and persist the returned token. Repeated signups with

        the same email return `HTTP 409 application/problem+json` with a hint

        to call `POST /api/v1/auth/token` instead.'
      security: []
      parameters:
      - in: header
        name: User-Agent
        required: true
        schema:
          type: string
        example: MyAgent/1.2.3 (+https://example.com)
      - in: header
        name: X-Agent-Installation-Id
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{8,128}$
        description: Stable per-installation UUID. Sent on every signup retry from the same install.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentSignupRequest'
            examples:
              minimal:
                value:
                  email: agent@example.com
                  agent_name: MyAgent
              with-password-and-contact:
                value:
                  email: agent@example.com
                  agent_name: MyAgent
                  password: correct-horse-battery-staple
                  contact_email: ops@example.com
                  accept_terms: true
      responses:
        '201':
          description: Account + user created; token is immediately usable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSignupResponse'
        '400':
          $ref: '#/components/responses/Problem'
        '409':
          description: Email already registered. Use POST /api/v1/auth/token to log in instead.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Too many signup attempts from this IP or installation id. Existing tokens are unaffected.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
components:
  schemas:
    AgentSignupResponse:
      type: object
      required:
      - access_token
      - apiToken
      - tokenType
      - header
      - alternateHeader
      - user
      - signup
      properties:
        access_token:
          type: string
          description: Bearer token usable on `/api/v1/*` and `/api/mcp`. Same value as `apiToken`.
        apiToken:
          type: string
          description: Alias of `access_token` for parity with POST /api/v1/auth/token.
        tokenType:
          type: string
          enum:
          - Bearer
        header:
          type: string
          example: 'Authorization: Bearer 0123456789abcdef0123456789abcdef'
        alternateHeader:
          type: string
          example: 'X-API-Token: 0123456789abcdef0123456789abcdef'
        user:
          type: object
          required:
          - id
          - email
          - accountId
          properties:
            id:
              type: integer
              format: int64
            email:
              type: string
              format: email
            displayName:
              type: string
            accountId:
              type: integer
              format: int64
            accountStatus:
              type: string
            apiEligible:
              type: boolean
        signup:
          type: object
          required:
          - verification
          - account_status
          properties:
            verification:
              type: string
              enum:
              - deferred
              description: Email verification is not required for token issuance in this slice.
            terms_accepted:
              type: boolean
            account_status:
              type: string
              example: ACTIVE
            agent_installation_id:
              type: string
              nullable: true
              description: Echo of the X-Agent-Installation-Id header (or body fallback) when one was supplied.
            guidance:
              type: string
              description: Plain-language reminder to persist the token and not call signup repeatedly.
    AuthTokenRequest:
      type: object
      required:
      - email
      - password
      properties:
        email:
          type: string
          format: email
          description: Compeller account email. `username` is also accepted as an alias.
          example: artist@example.com
        username:
          type: string
          description: Optional alias for `email`.
          example: artist@example.com
        password:
          type: string
          format: password
          writeOnly: true
    LoginRequest:
      type: object
      required:
      - username
      - password
      properties:
        username:
          type: string
          format: email
          example: artist@example.com
        password:
          type: string
          format: password
          writeOnly: true
    Problem:
      type: object
      description: RFC 7807 problem detail.
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          example: about:blank
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
    AuthTokenResponse:
      type: object
      required:
      - apiToken
      - tokenType
      - header
      - alternateHeader
      - user
      properties:
        apiToken:
          type: string
          description: Opaque Compeller API token. Use as a bearer token or X-API-Token.
          example: 0123456789abcdef0123456789abcdef
        tokenType:
          type: string
          enum:
          - Bearer
        header:
          type: string
          example: 'Authorization: Bearer 0123456789abcdef0123456789abcdef'
        alternateHeader:
          type: string
          example: 'X-API-Token: 0123456789abcdef0123456789abcdef'
        user:
          type: object
          required:
          - id
          - email
          - accountId
          properties:
            id:
              type: integer
              format: int64
            email:
              type: string
              format: email
            displayName:
              type: string
            accountId:
              type: integer
              format: int64
            accountStatus:
              type: string
            apiEligible:
              type: boolean
              description: Whether this account is currently eligible to run authenticated API jobs.
    LoginResponse:
      type: object
      required:
      - username
      - access_token
      properties:
        username:
          type: string
          format: email
        roles:
          type: array
          description: Included only when the user has roles beyond baseline ROLE_COMPELLER.
          items:
            type: string
        access_token:
          type: string
          description: 'Token accepted as `Authorization: Bearer <access_token>` on v1 REST and MCP calls.'
        refresh_token:
          type: string
          nullable: true
          description: Included only when the login backend returns a refresh token.
        expires_in:
          type: integer
          nullable: true
          description: Included only when the login backend returns an expiration.
    AgentSignupRequest:
      type: object
      required:
      - email
      - agent_name
      properties:
        email:
          type: string
          format: email
          example: agent@example.com
        agent_name:
          type: string
          minLength: 2
          maxLength: 128
          description: Human-readable agent or product name. `product_name` is also accepted as an alias.
          example: MyAgent
        product_name:
          type: string
          description: Alias for `agent_name`.
        password:
          type: string
          format: password
          minLength: 12
          writeOnly: true
          description: Optional. If omitted, a strong password is generated and discarded; reuse the returned token instead.
        contact_email:
          type: string
          format: email
          description: Optional secondary contact (e.g. ops@example.com). Recorded as an additional account identifier.
        accept_terms:
          type: boolean
          description: Optional acknowledgement of Compeller Terms of Service. Echoed back in the response.
        installation_id:
          type: string
          pattern: ^[A-Za-z0-9_-]{8,128}$
          description: Optional body fallback for `X-Agent-Installation-Id` when headers cannot be set. Header takes precedence.
  responses:
    Problem:
      description: RFC 7807 problem detail.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: 'Compeller API token sent as `Authorization: Bearer <token>`.'
    apiTokenHeader:
      type: apiKey
      in: header
      name: X-API-Token
      description: 'Compeller API token sent as `X-API-Token: <token>` (equivalent to bearer).'
x-refined-from:
- compeller-ai-openapi.yaml
- compeller-ai-openapi.yml