> ## Documentation Index
> Fetch the complete documentation index at: https://developers.liara.ir/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an API token

> Issues a new API token for your account. Existing tokens keep working. Tokens always belong to you, not to a team; to work with a team's resources, add the `teamID` query parameter to each request. Your account must be verified (see `isVerified` in `GET /v1/me`).



## OpenAPI

````yaml /spec/platform-auth.yaml post /v1/api-token
openapi: 3.0.1
info:
  title: Authentication & Account
  version: 1.0.0
  description: >-
    Log in, issue API tokens, change or reset your password, set up two-factor
    authentication, verify your email address and phone number, and manage your
    account profile and billing contact details.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Login
    description: Exchange your credentials or a one-time code for an API token.
  - name: Registration
    description: Create a new account.
  - name: Password
    description: Change your password while logged in, or reset a forgotten one.
  - name: API Tokens
    description: Issue additional API tokens for your account.
  - name: Account
    description: Read and update your profile and billing contact details.
  - name: Two-Factor Authentication
    description: Set up and manage authenticator-app (TOTP) two-factor authentication.
  - name: Verification
    description: Verify, or change, your account's email address and phone number.
paths:
  /v1/api-token:
    post:
      tags:
        - API Tokens
      summary: Create an API token
      description: >-
        Issues a new API token for your account. Existing tokens keep working.
        Tokens always belong to you, not to a team; to work with a team's
        resources, add the `teamID` query parameter to each request. Your
        account must be verified (see `isVerified` in `GET /v1/me`).
      operationId: createApiToken
      parameters:
        - $ref: '#/components/parameters/ExpiresIn'
      responses:
        '201':
          description: The token was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
              example:
                api_token: <api-token>
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountVerificationRequired'
components:
  parameters:
    ExpiresIn:
      name: expiresIn
      in: query
      required: false
      description: How long the issued token stays valid.
      schema:
        type: string
        enum:
          - 1h
          - 1d
          - 7d
          - 30d
          - 180d
          - 1y
        default: 30d
  schemas:
    TokenResponse:
      type: object
      properties:
        api_token:
          type: string
          description: 'API token to send as `Authorization: Bearer <api-token>`.'
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    ValidationError:
      description: The request is invalid. `message` says which field failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 400
            error: Bad Request
            message: >-
              "phone" with value "123" fails to match the required pattern:
              /^09\d{9}$/
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
    AccountVerificationRequired:
      description: >-
        Your account isn't verified yet. Set your full name and verify your
        email address, phone number and national code first.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            error: Forbidden
            message: You must verify your account, first.
            data:
              code: account_verification_required
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API token as `Authorization: Bearer <api-token>`. Tokens
        expire (30 days by default) and stop working when you change or reset
        your password.

````

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